List Document fields
/unified/e-signature/document_fields
Query Parameters
Refer Specifying query parameters in Truto APIs
The signing request on which the field is found
1 supported1 required
The unique identifier for the signing request
The document on which the field is found
1 supported1 required
The unique identifier for the document
The page number of which the field is found inside the document
2 properties
The X-axis coordinate position for the field
The Y-axis coordinate position for the field
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.
unifiedunifiedrawnormalizedstream
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
List of Document fields
The date and time when the document field was created
The document on which the field is found
1 supported
3 properties
The unique identifier for the document
The page number of which the field is found inside the document
2 properties
The X-axis coordinate position for the field
The Y-axis coordinate position for the field
The unique identifier for the document field
1 supported
Specifies if the field can be edited by the participants
1 supported
Specifies if the field is required to be filled by the participants to complete the signing request
1 supported
Human readable name for the field
1 supported
The participant who needs to fill this field
1 supported
1 property
The unique identifier of the participant
Raw data returned from the remote API call.
The signing request on which the field is found
1 supported
1 property
The unique identifier for the signing request
The type of the field
signatureinitialsfull_namesigning_datecompany_nametitletextemail
1 supported
The date and time when the document field was updated
curl -X GET 'https://api.truto.one/unified/e-signature/document_fields?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/e-signature/document_fields?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/e-signature/document_fields"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'e-signature',
'documentfields',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"e-signature",
"documentfields",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())