List Fields
/unified/forms/fields
Query Parameters
Refer Specifying query parameters in Truto APIs
6 supported6 required5 notes
The form to which the response belongs.
The form to which the response belongs.
The fields associated with the form.
The form to which the response belongs.
The form to which the response belongs.
The unique identifier of the form.
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 Fields
The field's columns. If present, the field's type is matrix
2 supported
3 properties
The column's description
The column's label
The column's value
The date and time of the field's creation
1 supported
The field's description
3 supported
The field's group identifier. If present, the field is part of a group.
5 supported
5 properties
The field group's description
The field groups's identifier
The field group's label
The field groups's name
The index position of field group in the form.
The format of the field.
urlemailpassword
5 supported
The field's unique identifier
6 supported
Whether the field is required
6 supported
The field's label
6 supported
The field's name. This is the name of the property in the entity.
6 supported
The field's options
6 supported
3 properties
The option's description
The option's label
The option's value
The field's placeholder
2 supported
The index position of field in the form.
3 supported
The range applicable for field types number, rating, scale.
6 supported
4 properties
The maximum range for the field.
The label for the maximum range of the field.
The minimum range for the field.
The label for the minimum range of the field.
Raw data returned from the remote API call.
The field's rows. If present, the field's type is matrix
2 supported
3 properties
The row's description
The row's label
The row's value
The field's type. If no clear mapping exists, then raw value is returned.
statementstringtextrich_textnumberbooleandatedatetimetimeenumarrayfileratingsliderscalerankinggroupmatrix_singlematrix_multiple+ 7 more
6 supported
The date and time of the field's last update
1 supported
The validation string for the field.
2 supported
curl -X GET 'https://api.truto.one/unified/forms/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/forms/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/forms/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(
'forms',
'fields',
{ 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(
"forms",
"fields",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())