Files
bookhoard/docs/developer/api/conflicts/list_conflicts.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

1.5 KiB

List Conflicts

List all sync conflicts for the current user.

Endpoint: GET /api/conflicts Auth: Required

Query Parameters

Parameter Type Required Description
status string No Filter by status (active, resolved, dismissed)
media_item_id string (UUID) No Filter by media item
limit integer No Maximum number of conflicts to return (default: 50)
offset integer No Number of conflicts to skip (default: 0)

Request Headers

Header Type Required Description
Authorization string Yes Bearer token

Example Request

GET /api/conflicts?status=active&limit=10
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (200 OK)

{
  "conflicts": [
    {
      "id": "uuid",
      "media_item_id": "book-uuid",
      "media_item_title": "Sample Book",
      "device_progress": {
        "device_id": "device-uuid",
        "device_name": "My Kobo",
        "percentage": 75,
        "position": 1234,
        "updated_at": "2026-02-08T10:00:00Z"
      },
      "server_progress": {
        "percentage": 50,
        "position": 800,
        "updated_at": "2026-02-08T09:00:00Z"
      },
      "status": "active",
      "created_at": "2026-02-08T10:00:00Z"
    }
  ],
  "total": 5,
  "limit": 10,
  "offset": 0
}

Error Responses

Code Description
401 Invalid or expired token