john-okeefe
b44e4e4709
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.
1001 B
1001 B
Get Shelf
Get all items on a device's shelf.
Endpoint: GET /api/devices/:id/shelves
Auth: Required
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Yes | Device UUID |
Request Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token |
Example Request
GET /api/devices/550e8400-e29b-41d4-a716-446655440000/shelves
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Response (200 OK)
{
"items": [
{
"id": "uuid",
"media_item_id": "uuid",
"title": "Book Title",
"authors": ["Author Name"],
"cover_url": "/api/media-items/uuid/cover",
"added_at": "2026-02-08T10:00:00Z"
}
],
"total": 15
}
Error Responses
| Code | Description |
|---|---|
| 401 | Invalid or expired token |
| 404 | Device not found |