Files
bookhoard/docs/api/notes/get_notes.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 Notes

Retrieve all notes for a specific media item.

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

Response (200 OK)

{
  "notes": [
    {
      "id": "uuid",
      "media_item_id": "uuid",
      "user_id": "uuid",
      "content": "This is an interesting passage...",
      "position": "epubcfi(/6/4/2:15)",
      "percentage_location": 0.45,
      "character_start": 15432,
      "character_end": 15480,
      "epubcfi_location": "epubcfi(/6/4/2:15)",
      "created_at": "2026-01-31T10:00:00Z",
      "updated_at": "2026-01-31T10:00:00Z"
    }
  ]
}

Error Responses

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

Try It Out