Wraps

List wraps

Lists the wraps owned by the API key's account, newest first, with keyset cursor pagination: all of them, or one book's (bookId) or one cover's (coverId). Wraps made in the browser wrap editor are listed too, Amazon KDP and Barnes & Noble designs alike. Metadata only: read a wrap's text and signed asset links with GET /api/v1/wraps/{wrapId}. Free.

get/api/v1/wraps

Request

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

Query parameters

bookIdstring uuid

Only this book's wraps.

coverIdstring uuid

Only the wraps built from this cover (its public id).

limitinteger

Page size (default 20, max 100).

cursorstring

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

Response

One page of wraps.

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.