---
title: "Book form data"
method: GET
path: "/v1/book/forms"
tags: ["Capture"]
---

# Book form data

`GET /v1/book/forms`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v1/book/forms`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

Retrieves data for all forms uploaded to a <<glossary:Book>>.

---

A detailed description of the response can be found on the [form data](https://docs.ocrolus.com/docs/form-data) data type definition.

## Query parameters

- `book_uuid` string
- `pk` integer

## 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.
    - `pk` integer: Unique primary key for the <<glossary:Book>>.
    - `uuid` string: Universally unique identifier (UUID) for the <<glossary:Book>>.
    - `name` string: Name of the <<glossary:Book>> from which information is retrieved.
    - `created` string: A timestamp of when the <<glossary:Book>> was created.
    - `created_ts` string: A timestamp of when the <<glossary:Book>> was created.
    - `verified_pages_count` integer: The total number of pages that have completed verficiation in this <<glossary:Book>>x.
    - `book_status` string: The verification status of the <<glossary:Book>>.
    - `id` integer: Unique primary key for the <<glossary:Book>>.
    - `forms` object[]: An array of forms that have been uploaded to this <<glossary:Book>>.
      - `pk` integer: Unique primary key for the form.
      - `uuid` string: Universally unique identifier (UUID) for the form.
      - `uploaded_doc_pk` integer: A unique integer of the <<glossary:Document>> that the form is associated with.
      - `form_type` string: The Document type of the form.
      - `doc_validations` object: A summary of validation results for the form. Present only when the validation summaries option is configured for your account. If not configured, this field is omitted.
      - `raw_fields` object: An object containing data related to the data captured from the form. This may vary amongst different form types.
        - `examplefield:field_name` object: Information recorded from the uploaded Document.
          - `value` string: The recorded value found in the field.
          - `is_empty` boolean: Describes if the field contains information.
          - `alias_used` string: Alias used for the field.
          - `source_filename` string: The source of the information recorded in the field.
          - `subfields` object: An optional object that contains information in nested fields.
            - `value` string: The recorded value found in the field.
            - `is_empty` boolean: Describes if the field contains information.
            - `alias_used` string: Alias used for the field.
            - `source_filename` string: The source of the information recorded in the field.
            - `confidence` number: The confidence score associated with this field.
      - `form_config_pk` integer: Unique primary key for the form config.
      - `tables` unknown[]: An array of tables associated with the form.
        - unknown
      - `attribute_data` object, nullable: Additional data related to the form.
        - `period_pk` integer: Unique primary key for a transaction period.
    - `book_is_complete` boolean: Determines if all Documents in the <<glossary:Book>> have completed verification.
  - `message` string: A textual description that indicates details about this response's status.

## Other responses

- `400`: Client Errors
- `500`: Internal Server Error

---

[API](https://skmtc.dev/ocrolus/apis/capture.md) - [All operations](https://skmtc.dev/ocrolus/apis/capture/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/capture/revisions/4bc747954163?raw)