Book list

This API retrieves a list of all Books available to the current user. It returns the following two different response shapes depending on whether the limit parameter is supplied, select the schema and example that matches your use case:

  • Unpaginated: When limit is omitted, the response is a bare array of Book objects with no wrapper.
  • Paginated: When limit is supplied, the response is an object containing _links, limit, total_book_count, and books.

📘

Note

  • By default results are ordered by Book PK in descending order but you can alter how and what books are returned by providing different parameters with your request.
  • Use the name query parameter to find a Book by an exact name. This will be faster than search which uses approximate string matching algorithm.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter books by book class. If COMPLETE is among the values, books with no class set are also included.

Allowed:
integer

Maximum number of Books to return per page. When omitted, the endpoint returns all matching Books as a bare JSON array with no pagination wrapper. When supplied, the response changes to a paginated object containing _links, limit, total_book_count, and books.

integer

Number of Books to skip before returning results. Use with limit to paginate through large collections. The list is index-based and starts at integer 0. An offset of 10 skips the first 10 results.

string
enum

Sort direction for the results. DESC returns the newest Books first (default) whereas ASC returns the oldest first. By default, results are returned in descending order.

Allowed:
string
enum

Field to sort the results by. Use created to sort by creation date, name to sort alphabetically, or pk to sort by Book ID.

Allowed:
string

Returns only the Book whose name matches this value exactly.

Return Books whose names approximately match the search term.

string

Return only the Book whose external ID (xid) matches this value exactly.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json