Files
bookhoard/docs/api/progress/get_progress.md
T
john-okeefe 284486f0a0 docs: add progress, notes, and highlights API endpoints
Phase 2 part 4: Split reading progress and annotation endpoints
- Progress: get_progress, update_progress, delete_progress
- Notes: get_notes, create_note, update_note, delete_note
- Highlights: get_highlights, create_highlight, update_highlight, delete_highlight
- All endpoints support EPUB CFI and percentage locations
2026-02-02 08:51:48 -05:00

1.2 KiB

Get Reading Progress

Retrieve reading progress for a specific media item.

Endpoint: GET /api/media-items/{media_id}/progress 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/progress
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (200 OK)

{
  "media_item_id": "uuid",
  "user_id": "uuid",
  "current_page": 45,
  "total_pages": 200,
  "percentage": 0.225,
  "character_offset": 15432,
  "epubcfi": "epubcfi(/6/4/2:15)",
  "chapter": 3,
  "chapter_progress": 0.5,
  "last_read_at": "2026-01-31T10:00:00Z",
  "format_group": "reflowable",
  "viewport_y": 0.12,
  "zoom_level": 1.0
}

Error Responses

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

Try It Out