Files
bookhoard/docs/developer/api/ratings/get_ratings.md
T
john-okeefe b44e4e4709 docs: remove Phase X placeholders from API documentation
Clean up API documentation files by removing Phase X references:

Remove 'API Explorer will be inserted here in Phase X' placeholders from:
- 70+ API endpoint documentation files
- Authentication endpoints (login, logout, register, refresh)
- User endpoints (profile, settings, password)
- Device endpoints (registration, sync, shelves)
- Library endpoints (CRUD, folders, visibility)
- Media endpoints (items, progress, highlights, notes)
- Admin endpoints (users, analytics)
- Sync endpoints (Kobo, KOReader)
- OPDS endpoints
- Scanner endpoints
- Queue endpoints

These placeholders were from planning documents and have no meaning
to API consumers. The documentation is now clean and ready for use.
2026-02-13 21:50:44 -05:00

941 B

Get Rating

Retrieve the current user's rating for a media item.

Endpoint: GET /api/media-items/{media_id}/rating Auth: Required

Path Parameters

Parameter Type Required Description
media_id string Yes Media item UUID

Request Headers

Header Type Required Description
Authorization string Yes Bearer token

Example Request

GET /api/media-items/uuid/rating
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (200 OK)

{
  "rating": 8,
  "user_id": "uuid",
  "media_item_id": "uuid"
}

Rating Scale: 1-10 (odd numbers = half-stars: 1=0.5★, 2=1★, 3=1.5★, ..., 9=4.5★, 10=5★)

Error Responses

Code Description
401 Invalid or expired token
404 Media item not found or no rating set