Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
🎉 ReadingStepsUI V2 is now out — preview it at readingsteps.uk or in app betas from 19th September
API endpoints for managing user accounts and profiles.
https://api.readingsteps.uk/v1/users
GET /users/me Authorization: Bearer YOUR_ACCESS_TOKEN
{ "id": "usr_abc123", "email": "user@example.com", "name": "John Doe", "avatar": "https://cdn.readingsteps.uk/avatars/usr_abc123.jpg", "reading_level": "intermediate", "created_at": "2024-01-15T10:30:00Z", "preferences": { "font_size": 16, "theme": "light", "notifications": true } }
GET /users/{user_id} Authorization: Bearer YOUR_ACCESS_TOKEN
{ "id": "usr_abc123", "name": "John Doe", "avatar": "https://cdn.readingsteps.uk/avatars/usr_abc123.jpg", "reading_level": "intermediate", "books_read": 42, "member_since": "2024-01-15" }
PATCH /users/me Authorization: Bearer YOUR_ACCESS_TOKEN Content-Type: application/json { "name": "Jane Doe", "avatar": "https://example.com/avatar.jpg", "preferences": { "font_size": 18, "theme": "dark" } }
{ "id": "usr_abc123", "email": "user@example.com", "name": "Jane Doe", "avatar": "https://example.com/avatar.jpg", "preferences": { "font_size": 18, "theme": "dark", "notifications": true } }
DELETE /users/me Authorization: Bearer YOUR_ACCESS_TOKEN
{ "success": true, "message": "Account deleted successfully" }
GET /users/{user_id}/stats Authorization: Bearer YOUR_ACCESS_TOKEN
{ "user_id": "usr_abc123", "total_reading_time": 125000, "books_completed": 42, "pages_read": 12500, "average_reading_speed": 250, "vocabulary_size": 3500, "current_streak": 15, "longest_streak": 30 }
{ "error": { "code": "user_not_found", "message": "The requested user could not be found", "details": {} } }