Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Book Queries

Book list

Retrieve a list of all <glossary:Book>s available to the current user.

📘

  • By default results are ordered by <glossary: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 <glossary:Book> by an exact name. This will be faster than search which uses approximate string matching algorithm.
get/v1/books

Query parameters

limitinteger

Sets the number of results to return.

offsetinteger

Sets the starting point of the results list. The list is index-based and starts at integer 0.

order'ASC' | 'DESC'

By default, results are returned in descending order, which is newest to oldest.

order_by'created' | 'name' | 'pk'

Determines what field to order the results by.

namestring

Filter books by name (exact match)

searchstring

Filter books by keyword search on book_name

xidstring

Filter books by xid (exact match)

Response

Success

statusnumber

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": [
    {
      "xid": "123ABC",
      "book_type": "DEFAULT"
    }
  ],
  "message": "Ok"
}