---
title: "List Fields by Document ID"
method: GET
path: "/sign/envelopes/{envelopeID}/documents/{documentID}/fields"
tags: ["Sign"]
---

# List Fields by Document ID

`GET /sign/envelopes/{envelopeID}/documents/{documentID}/fields`

The **List Fields by Document ID** endpoint retrieves all fields associated with a specific document within an envelope. The request must include the envelope and document ID to ensure the complete set of fields is retrieved for the correct document.

## Path parameters

- `envelopeID` string, uuid, required
- `documentID` string, uuid, required

## Response `200`

List of all fields. Each field contains its unique ID and configuration.

- union
  - Checkbox — Response representing a Checkbox field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `type` 'checkbox', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Company — Response representing a Company field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `type` 'company', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Custom — Response representing a Custom field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `label` string, required — Descriptive label of the Custom field
    - `type` 'custom', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Date — Response representing a Date field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `format` string, required — Format of the Date field. The following date format options are supported (examples use September 10, 2025): - `MM/DD/YYYY` → 09/10/2025 - `MM-DD-YYYY` → 09-10-2025 - `MMM DD YYYY` → Sep 10 2025 - `DD/MM/YYYY` → 10/09/2025 - `DD MMM YYYY` → 10 Sep 2025 - `DD MMMM YYYY` → 10 September 2025 - `YYYY/MM/DD` → 2025/09/10 - `YYYY-MM-DD` → 2025-09-10 - `YYYY-MMM-DD hh:mm` → 2025-Sep-10 14:30
    - `modifiable` boolean — A boolean that indicates that the participant can change value of the field.
    - `type` 'date', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Initials — Response representing an Initials field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `type` 'initials', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Name — Response representing a Name field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `type` 'name', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Signature — Response representing a Signature field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `type` 'signature', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.
  - Title — Response representing a Title field
    - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.
    - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box).
    - `required` boolean — A boolean that indicates whether the participant must complete the field.
    - `type` 'title', required
    - `ID` string, uuid — Unique ID of the field
    - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.
    - `documentID` string, uuid, required — ID of the document to which this field belongs.

## Other responses

- `401` — Unauthorized - Invalid or missing JWT token
- `404` — Envelope or document not found

---

[API](https://skmtc.net/gonitro/apis/nitro-sign-public-api.md) · [All operations](https://skmtc.net/gonitro/apis/nitro-sign-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gonitro/nitro-sign-public-api/revisions/26e3043a365b/schema)