Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Book Queries

Book status

Retrieve the status of a <glossary:Book>.

This endpoint can also be used to keep track of the status of the Documents within the <glossary:Book>.

For more information about the various processing statuses of a <glossary:Book> during its life cycle, visit our guide on Book Statuses.

Similarly, if you are interested in knowing more about the different stages of Document processing, visit our guide on Document Statuses.

get/v1/book/status

Query parameters

book_uuidstring uuid

The unique identifier of the <glossary:Book> whose status you want to retrieve. Mutually exclusive with book_pk.

pkstring

Unique primary key (pk) of the <glossary:Book> whose status you want to retrieve. Mutually exclusive with book_uuid.

Response

Success

statusinteger

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": {
    "created": "2023-03-03T04:36:31Z",
    "created_ts": "2023-03-03T04:36:31Z",
    "owner_email": "email@address.com",
    "is_public": true,
    "uuid": "19aab921-25a5-4beb-a59e-ac72320061d6",
    "id": 30219565,
    "is_shared_or_public_book": true,
    "book_status": "VERIFIED"
  },
  "message": "Ok"
}