List Job form fields
/unified/ats/job_form_fields
Query Parameters
Refer Specifying query parameters in Truto APIs
The job's unique identifier
4 supported4 required
The ID of the organization to filter the job form fields by.
1 supported
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 Job form fields
The form field's unique identifier
4 supported
The form field's answer visibility inside the ATS.
privatepublic
1 supported
The form field's description.
3 supported
The form field's group identifier. If present, the form field is part of a group.
1 supported
The form field's group name or label. If present, the form field is part of a group.
2 supported
The form field's position inside a form. If group_id is present, the index is relative to the group.
4 supported
Whether the form field is required or not.
4 supported
The form field's job
4 supported
1 property
Unique identifier of the job
The form field's label.
3 supported
The form field's name. Use this when submitting the application.
4 supported
The form field's options. Only present for dropdown, radio and checkbox types.
3 supported
3 properties
The option's unique identifier
The option's label
The option's value
Raw data returned from the remote API call.
The form field's type. If no clear mapping exists, then raw value is returned.
texttextareadropdownfileradiocheckboxdatenumber
3 supported
curl -X GET 'https://api.truto.one/unified/ats/job_form_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/ats/job_form_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/ats/job_form_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(
'ats',
'jobformfields',
{ 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(
"ats",
"jobformfields",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())