---
title: "Book status"
method: GET
path: "/v1/book/status"
tags: ["Book Queries"]
---

# Book status

`GET /v1/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](https://docs.ocrolus.com/ocrolus-api/docs/book-status-code).

Similarly, if you are interested in knowing more about the different stages of Document processing, visit our guide on [Document Statuses](https://docs.ocrolus.com/ocrolus-api/docs/document-status).

## Query parameters

- `book_uuid` string, uuid
- `pk` string

## Response `200`

Success

- object
  - `status` integer — A numerical code that indicates the status of the request.
  - `response` object — An object received from the server that potentially contains data.
    - `name` integer — Name of the <<glossary:Book>> whose status is retrieved.
    - `created` string — A timestamp of when the <<glossary:Book>> was created.
    - `created_ts` string — The timestamp at which <<glossary:Book>> was created.
    - `pk` integer — Unique identifier (primary key) for the <<glossary:Book>>.
    - `owner_email` string — Name of the owner who has created the <<glossary:Book>>.
    - `is_public` boolean — Indicates if all users in your organization can see and upload <<glossary:Document>>s into this <<glossary:Book>>."
    - `uuid` string — Universally unique identifier (UUID) for the <<glossary:Book>>.
    - `id` integer — Unique identifier for the <<glossary:Book>>.
    - `is_shared_or_public_book` boolean — Indicates if this <<glossary:Book>> is a public <<glossary:Book>> and can be shared with other users.
    - `docs` array[] — An array of all the documents uploaded to the <<glossary:Book>>.
      - unknown[]
        - unknown
    - `mixed_docs` array[] — An array of all the Mixed Documents uploaded to the <<glossary:Book>>. A Mixed Document is a single or multipage PDF that contains more than one doc type. This array is optional and is only returned when the <<glossary:Book>> has Mixed Documents uploaded to it.
      - unknown[]
        - unknown
    - `book_status` string — Status of the <<glossary:Book>>.
    - `book_class` string — The processing type of the book. Can be either 'COMPLETE' or 'INSTANT'.
  - `message` string — A textual description that indicates details about this response's status.

## Other responses

- `400` — Client Errors

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)