---
title: "Doc form data"
method: GET
path: "/v1/document/forms/fields"
tags: ["Capture"]
---

# Doc form data

`GET /v1/document/forms/fields`

## Request

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

Retrieves data for all <<glossary:Form>>s captured in a <<glossary:Document>>.

---

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

- `doc_uuid` string
- `pk` integer
- `include_all` boolean

## Response `200`

200

- 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:Document>>.
    - `uuid` string: Universally unique identifier (UUID) for the <<glossary:Document>>.
    - `forms` object[]: An array of forms that have been found in this <<glossary:Document>>.
      - `pk` integer: Unique primary key for the form.
      - `uuid` string: Universally unique identifier (UUID) for the form.
      - `form_type` string: The Document type of the form.
      - `form_config_pk` integer: Unique primary key for the form config.
      - `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.
      - `tables` unknown[]: An array of tables associated with the form.
        - unknown
      - `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.
          - `confidence` number: The confidence score associated with this field.
  - `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)