Skip to main content
GET
/
sign
/
envelopes
/
{envelopeID}
/
documents
/
{documentID}
/
fields
List Fields by Document ID
curl --request GET \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID}/fields \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "fieldID": "987e6543-e21b-12d3-a456-426614174999",
      "participantID": "123e4567-e89b-12d3-a456-426614174000",
      "documentID": "456e7890-e12b-34d5-a678-426614175000",
      "page": 1,
      "boundingBox": [
        100,
        200,
        150,
        50
      ],
      "required": true,
      "type": "signature"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique string that identifies the envelope in the Nitro system.

​
documentID
string<uuid>
required

A unique string that identifies the document in the Nitro system.

Response

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

Response representing a Checkbox field

​
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.

Required string length: 4
Example:
[100, 200, 150, 50]
​
type
enum<string>
required
Available options:
checkbox
​
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.

​
page
integer<int32>

The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.

​
required
boolean

A boolean that indicates whether the participant must complete the field.

​
ID
string<uuid>

Unique ID of the field