---
title: "GET /documents/{document_id}/fields"
method: GET
path: "/documents/{document_id}/fields"
tags: ["Prefill"]
---

# GET /documents/{document_id}/fields

`GET /documents/{document_id}/fields`

## Request

- Base URL: `https://api-docs.simplepdf.com/api/v1`
- URL: `https://api-docs.simplepdf.com/api/v1/documents/{document_id}/fields`
- Auth: HTTP bearer

Retrieve the field schema of a document. Each field is what you specify in the prefill blob you upload to storage: a blob entry is `{ id, value }`, where `id` is this field's `id` and `value` is the value to prefill. When `options` is set, `value` must be one of them; otherwise `value` is a string (text or checkbox value) or a data URL (signature, picture). Returns 409 when the document has no configured fields. Configure fields via the dashboard first.

## Path parameters

- `document_id` string, uuid, required

## Response `200`

Successful response

- object
  - `data` object[], required
    - `id` string, required: Stable field identifier. Use as the `id` key in the prefill blob.
    - `name` string, nullable, required: Curated field name.
    - `type` 'text' | 'comb_text' | 'checkbox' | 'signature' | 'picture' | 'dropdown' | 'radio', required: `comb_text` is a text field laid out one character per box. `dropdown` and `radio` are acrofield-only.
    - `page` integer, required: 1-indexed page number.
    - `options` string[], nullable, required: Valid values for constrained fields (checkbox, dropdown, radio). `null` otherwise.
    - `default_value` boolean, required: Whether a default value exists. The actual value is stored in storage and loaded client-side; it is never exposed via the API.
    - `required` boolean, required: Whether the field must be filled before submitting.
    - `read_only` boolean, required: Template-level lock. Always takes precedence.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Not found
- `409`: Conflict
- `429`: Too many requests

---

[API](https://skmtc.dev/simplepdf/apis/simplepdf-api.md) · [All operations](https://skmtc.dev/simplepdf/apis/simplepdf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/simplepdf/apis/simplepdf-api/revisions/0bc3915e908d?raw)