Books

List books

Lists books owned by the API key's account, newest first, with keyset cursor pagination. Hidden books stay out unless include_hidden=true, as on the dashboard shelf. Each book carries its cover count and its shelf thumbnail (thumbnail_cover_id).

get/api/v1/books

Request

Base URL: https://beyourcover.com
URL: https://beyourcover.com/api/v1/books
Auth: HTTP bearer

Query parameters

limitinteger

Page size (default 20, max 100).

cursorstring

Opaque cursor from a previous response's next_cursor. Omit for the first page.

qstring

Only books whose title or author contains this text (case-insensitive).

include_hiddenboolean

Also list books hidden from the shelf.

source_type'generated' | 'external_wrap' | 'premade'

Only books of this kind.

Response

One page of books.

next_cursorstring nullable required

Pass as cursor to fetch the next page. null when there are no more results.

Changes

No recorded changes to this operation across all 1 revision of this API.