Field
Lists the Fields of a Signature Request Document.
Returns a list of Fields for a given Document. You can limit the number of items returned by using filters.
get/signature_requests/{signatureRequestId}/documents/{documentId}/fields
Path parameters
signatureRequestIdstring uuid required
The unique identifier for a resource.
Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c
Signature Request Id
documentIdstring uuid required
The unique identifier for a resource.
Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c
Document ID
Query parameters
afterstring
After cursor (pagination)
limitinteger
The limit of items count to retrieve.
typeobject
Filter by type.
Filter by type. Allowed operators: eq, in. Example: type[in]=text,checkbox
signer_idobject
Filter by signer_id.
Filter by signer_id. Allowed operators: eq. Example: signer_id[eq]=500800fc-3f91-4e86-a9c9-866809a1e3c9
nameobject
Filter by name.
Filter by name. Allowed operators: eq. Example: name[eq]=text 1
Response
OK
Example response
{
"data": [
{
"id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
"document_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
"signer_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
"display": {
"options": {
"date_format": "dd/MM/yyyy",
"time_format": "HH:mm"
}
}
}
]
}