Appearance

List Document fields ​

Endpoint ​

http
GET /unified/e-signature/document_fields
Integrations supported
  • DocuSign

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
signing_request
object

The signing request on which the field is found

Required in
  • DocuSign
id
string

The unique identifier for the signing request

document
object

The document on which the field is found

Required in
  • DocuSign
id
string

The unique identifier for the document

page_number
string

The page number of which the field is found inside the document

position
object
x
string

The X-axis coordinate position for the field

y
string

The Y-axis coordinate position for the field

Response Body ​

result
object[]

List of Document fields

id
string

The unique identifier for the document field

Supported in
  • DocuSign
label
string

Human readable name for the field

Supported in
  • DocuSign
type
string

The type of the field

All possible enum values:
  • signature
  • initials
  • full_name
  • signing_date
  • company_name
  • title
  • text
  • email
Supported in
  • DocuSign
is_read_only
boolean

Specifies if the field can be edited by the participants

Supported in
  • DocuSign
is_required
boolean

Specifies if the field is required to be filled by the participants to complete the signing request

Supported in
  • DocuSign
document
object

The document on which the field is found

Supported in
  • DocuSign
id
string

The unique identifier for the document

page_number
string

The page number of which the field is found inside the document

position
object
x
string

The X-axis coordinate position for the field

y
string

The Y-axis coordinate position for the field

signing_request
object

The signing request on which the field is found

Supported in
  • DocuSign
id
string

The unique identifier for the signing request

participant
object

The participant who needs to fill this field

Supported in
  • DocuSign
id
string

The unique identifier of the participant

created_at
string · date-time

The date and time when the document field was created

updated_at
string · date-time

The date and time when the document field was updated

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.