Create a job
POST/ats/{connection_id}/job
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
descriptionstring
recruiter_idsstring array
hiring_manager_idsstring array
status enum
Valid values:
"ARCHIVED"
"PENDING"
"DRAFT"
"OPEN"
"CLOSED"
closed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
remoteboolean
language_localestring
Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)
public_job_urlsstring array
URLs for pages containing public listings for the job
number_of_openingsnumber
Number of openings for the job
company_idstring
id value of the company associated with the job in the ATS (reference to AtsCompany)
minimum_experience_yearsnumber
minimum_degreestring
skillsstring array
user_idstring
User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)
industrystring
summarystring
Short job blurb (distinct from full description when both exist)
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
description | string | No | |
recruiter_ids | string[] | No | |
hiring_manager_ids | string[] | No | |
hiring_managers | AtsReference[] | No | |
hiring_managers[].id | string | No | |
hiring_managers[].name | string | No | |
status | enum | No | Values: ARCHIVED, PENDING, DRAFT, OPEN, CLOSED |
closed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
addresses | AtsAddress[] | No | |
addresses[].address1 | string | No | |
addresses[].address2 | string | No | |
addresses[].city | string | No | |
addresses[].region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
addresses[].region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
addresses[].postal_code | string | No | |
addresses[].country | string | No | |
addresses[].country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
compensation | AtsCompensation[] | No | |
compensation[].type | enum | No | Values: SALARY, BONUS, STOCK_OPTIONS, EQUITY, OTHER |
compensation[].min | number | No | |
compensation[].max | number | No | |
compensation[].currency | string | No | |
compensation[].frequency | enum | No | Values: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK |
employment_type | enum | No | Values: FULL_TIME, PART_TIME, CONTRACTOR, INTERN, CONSULTANT, VOLUNTEER, CASUAL, SEASONAL, FREELANCE, OTHER |
remote | boolean | No | |
language_locale | string | No | Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us) |
public_job_urls | string[] | No | URLs for pages containing public listings for the job |
number_of_openings | number | No | Number of openings for the job |
company_id | string | No | id value of the company associated with the job in the ATS (reference to AtsCompany) |
questions | AtsJobQuestion[] | No | |
questions[].id | string | No | |
questions[].question | string | Yes | |
questions[].required | boolean | No | |
questions[].description | string | No | |
questions[].prompt | string | No | |
questions[].type | enum | Yes | Values: TEXT, NUMBER, DATE, BOOLEAN, MULTIPLE_CHOICE, FILE, TEXTAREA, MULTIPLE_SELECT, UNIVERSITY, YES_NO, CURRENCY, URL |
questions[].options | string[] | No | |
questions[].min_length | number | No | minimum answer length (TEXT) |
questions[].max_length | number | No | maximum answer length (TEXT) |
questions[].min_value | number | No | minimum answer value (NUMBER) |
questions[].max_value | number | No | maximum answer value (NUMBER) |
questions[].min_at | string (date-time) | No | earliest allowed answer (DATE) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
questions[].max_at | string (date-time) | No | latest allowed answer (DATE) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
questions[].parent_id | string | No | id of the question in this job's questions list that this question depends on |
questions[].parent_answer_values | string[] | No | only ask this question when the parent question's answer is one of these |
postings | AtsJobPosting[] | No | Public job postings |
postings[].id | string | No | |
postings[].created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
postings[].updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
postings[].posting_url | string | No | |
postings[].name | string | No | job-post-specific name |
postings[].description | string | No | job-post-specific description |
postings[].address | AtsJobPosting_address | No | job-post-specific address |
postings[].address.address1 | string | No | |
postings[].address.address2 | string | No | |
postings[].address.city | string | No | |
postings[].address.region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
postings[].address.region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
postings[].address.postal_code | string | No | |
postings[].address.country | string | No | |
postings[].address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
postings[].location | string | No | job-post-specific location |
postings[].is_active | boolean | No | |
groups | AtsGroup[] | No | The departments/divisions/teams that this job belongs to |
groups[].id | string | No | |
groups[].name | string | No | |
groups[].type | enum | No | Values: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS_UNIT, BRANCH, SUB_DEPARTMENT |
openings | AtsJobOpening[] | No | |
openings[].status | enum | No | Values: OPEN, CLOSED |
openings[].opened_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
openings[].closed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
openings[].application_id | string | No | points to an application |
openings[].close_reason | string | No | |
minimum_experience_years | number | No | |
minimum_degree | string | No | |
skills | string[] | No | |
metadata | AtsMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | Actual textual value of the slug |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
user_id | string | No | User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee) |
industry | string | No | |
summary | string | No | Short job blurb (distinct from full description when both exist) |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/ats/5de520f96e439b002043d8dc/job',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know