Create Jobs
/unified/ats/jobs
Query Parameters
Refer Specifying query parameters in Truto APIs
Breezy company ID; the connected account company is used when omitted.
1 supported
ISO 3166-1 alpha-2 country code required by Breezy.
1 supported1 required
State or province accepted by Breezy.
1 supported
City accepted by Breezy.
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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.
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]=barRequest Body
Refer Writing data using Unified APIs
1 supported
The job's compensation currency
The job's compensation unique identifier
The job's compensation interval. If no clear mapping exists, then raw value is returned.
yearlymonthlyweeklydailyhourlyone_timesemi_monthlybi_monthlybi_weeklyhourlydailyweeklybi_weeklymonthlyyearly+ 3 more
Whether the job's compensation is negotiable or not
The job's maximum compensation
The job's minimum compensation
The job's compensation notes
Whether the job is confidential or not
2 supported
The job's department
2 supported
Unique identifier of the department
The department's name
Job description; Teamtailor accepts simple HTML.
2 supported2 required
Whether the job is remote or not
2 supported
The job's position level.
1 supported
The job's type.
full_timepart_timecontractinternshiptemporaryvolunteerper_diemfull_timepart_timecontracttemporary
1 supported1 required
full_timepart_timecontracttemporaryJob title.
2 supported2 required
The job's office
1 supported
Unique identifier of the office
The office's name
The job's recruiters
2 supported1 required
Unique identifier of the user
The user's name
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.
The job's requisition_id
1 supported
Mapped to Teamtailor open/archived/draft/unlisted states.
opencloseddraftpendingarchivedopendraftpendingarchived
2 supported
opendraftpendingarchivedThe job's tags
2 supported
Response Body
The job's unique identifier
2 supported
The date and time of the job's closing
The job's code
1 supported
1 supported
The job's compensation currency
The job's compensation unique identifier
The job's compensation interval. If no clear mapping exists, then raw value is returned.
yearlymonthlyweeklydailyhourlyone_timesemi_monthlybi_monthlybi_weekly
Whether the job's compensation is negotiable or not
The job's maximum compensation
The job's minimum compensation
The job's compensation notes
Whether the job is confidential or not
2 supported
The date and time of the job's creation
2 supported
The job's department
2 supported
Unique identifier of the department
The department's name
The job's description
2 supported
The job's hiring managers
1 supported
Unique identifier of the user
The user's name
Whether the job is remote or not
2 supported
The job's position level.
1 supported
The job's job posting urls
1 supported
The job posting URL's type
The job posting URL
The job's type.
full_timepart_timecontractinternshiptemporaryvolunteerper_diem
1 supported
The job's locations
1 supported
The job's name
2 supported
The job's office
1 supported
Unique identifier of the office
The office's name
The date and time of the job's opening
The job's recruiters
2 supported
Unique identifier of the user
The user's name
Raw data returned from the remote API call.
The job's requisition_id
1 supported
The job's status
opencloseddraftpendingarchived
2 supported
The job's tags
2 supported
The date and time of the job's last update
2 supported
truto unified ats jobs \
-m create \
-a '<integrated_account_id>' \
-b '{
"name": "your_name",
"description": "your_description",
"requisition_id": "your_requisition_id",
"departments": [],
"tags": [],
"is_remote": true,
"job_type": "full_time",
"job_position_level": "your_job_position_level",
"compensation": {},
"status": "open",
"confidential": true,
"offices": [],
"recruiters": [],
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.create(
'ats',
'jobs',
{
"name": "your_name",
"description": "your_description",
"requisition_id": "your_requisition_id",
"departments": [],
"tags": [],
"is_remote": true,
"job_type": "full_time",
"job_position_level": "your_job_position_level",
"compensation": {},
"status": "open",
"confidential": true,
"offices": [],
"recruiters": [],
"remote_data": {}
},
{ 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():
result = await truto_api.unified_api.create(
"ats",
"jobs",
{
"name": "your_name",
"description": "your_description",
"requisition_id": "your_requisition_id",
"departments": [],
"tags": [],
"is_remote": True,
"job_type": "full_time",
"job_position_level": "your_job_position_level",
"compensation": {},
"status": "open",
"confidential": True,
"offices": [],
"recruiters": [],
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X POST 'https://api.truto.one/unified/ats/jobs?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "your_name",
"description": "your_description",
"requisition_id": "your_requisition_id",
"departments": [],
"tags": [],
"is_remote": true,
"job_type": "full_time",
"job_position_level": "your_job_position_level",
"compensation": {},
"status": "open",
"confidential": true,
"offices": [],
"recruiters": [],
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"name": "your_name",
"description": "your_description",
"requisition_id": "your_requisition_id",
"departments": [],
"tags": [],
"is_remote": true,
"job_type": "full_time",
"job_position_level": "your_job_position_level",
"compensation": {},
"status": "open",
"confidential": true,
"offices": [],
"recruiters": [],
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/ats/jobs?integrated_account_id=${integratedAccountId}`, {
method: 'POST',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
body: JSON.stringify(body),
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/ats/jobs"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"name": "your_name",
"description": "your_description",
"requisition_id": "your_requisition_id",
"departments": [],
"tags": [],
"is_remote": True,
"job_type": "full_time",
"job_position_level": "your_job_position_level",
"compensation": {},
"status": "open",
"confidential": True,
"offices": [],
"recruiters": [],
"remote_data": {}
}
response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())