Deel: ATS schemas (part 2)
80 Deel schemas with complete fields and constraints.
← ATS operations · All schemas
Retrieve ATS job — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_pause_period | JSON | Optional | The pause currently in effect. Set only when status is PAUSED; null otherwise. |
active_pause_period (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data active pause period id, paused at |
active_pause_period (anyOf 2) | null | Alternative | |
applications_count | JSON | Optional | |
applications_count (anyOf 1) | JSON | Alternative | |
applications_count (anyOf 1) (anyOf 1) | integer | Alternative | Number of applications for the job |
applications_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
applications_count (anyOf 2) | null | Alternative | Number of applications for the job |
approval_request | JSON | Required within parent | Approval request for the job. Null when the job never went through approval. |
approval_request (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at |
approval_request (anyOf 2) | null | Alternative | |
approval_request_id | JSON | Optional | |
approval_request_id (anyOf 1) | string | Alternative | Unique identifier for the approval request Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | Unique identifier for the approval request Format: uuid |
approval_rule_id | JSON | Optional | |
approval_rule_id (anyOf 1) | string | Alternative | Unique identifier for the approval rule Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | Unique identifier for the approval rule Format: uuid |
closed_at | JSON | Optional | |
closed_at (anyOf 1) | string | Alternative | When the job was closed. Null when it is not closed. Format: date-time |
closed_at (anyOf 2) | null | Alternative | When the job was closed. Null when it is not closed. Format: date-time |
closure_reason | JSON | Required within parent | Why the job was closed. Null when the job is not closed or no reason was recorded. |
closure_reason (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data closure reason id, name |
closure_reason (anyOf 2) | null | Alternative | |
created_at | string | Optional | Timestamp when the job was created Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | Unique identifier of the user who created the job Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | Unique identifier of the user who created the job Format: uuid |
current_compensation | JSON | Optional | |
current_compensation (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY |
current_compensation (anyOf 2) | null | Alternative | |
hiring_member_job_permissions_by_type_slug | JSON | Optional | |
hiring_member_job_permissions_by_type_slug (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting |
hiring_member_job_permissions_by_type_slug (anyOf 2) | null | Alternative | |
hiring_members | JSON | Optional | |
hiring_members (anyOf 1) | array | Alternative | Hiring members associated with the job |
hiring_members (anyOf 1)[] | Model | Each item | Expand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item |
hiring_members (anyOf 2) | null | Alternative | Hiring members associated with the job |
hiring_members (anyOf 2)[] | Model | Each item | Expand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item |
id | string | Required within parent | Unique identifier for the job Format: uuid |
interview_plan_stages | array | Required within parent | Interview plan stages that currently hold at least one application, ordered by position. |
interview_plan_stages[] | Model | Each item | Expand Retrieve ATS job — 200 response body — data interview plan stages item |
is_confidential | boolean | Optional | Indicates if the job is confidential |
job_departments | JSON | Optional | |
job_departments (anyOf 1) | array | Alternative | Departments associated with the job |
job_departments (anyOf 1)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_departments (anyOf 2) | null | Alternative | Departments associated with the job |
job_departments (anyOf 2)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_employment_types | array | Optional | Employment types associated with the job |
job_employment_types[] | Model | Each item | Expand Create ATS Job — 201 response body — data job employment types item |
job_locations | array | Optional | Locations associated with the job |
job_locations[] | Model | Each item | Expand Create ATS Job — 201 response body — data job locations item |
job_teams | JSON | Optional | |
job_teams (anyOf 1) | array | Alternative | Teams associated with the job |
job_teams (anyOf 1)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job teams item |
job_teams (anyOf 2) | null | Alternative | Teams associated with the job |
job_teams (anyOf 2)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job teams item |
opened_at | JSON | Optional | |
opened_at (anyOf 1) | string | Alternative | When the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened. Format: date-time |
opened_at (anyOf 2) | null | Alternative | When the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened. Format: date-time |
richtext_description | JSON | Optional | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the job |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the job |
status | string | Required within parent | Job status. PAUSED jobs are open but temporarily not accepting candidates; see active_pause_period. Known values: OPEN, PAUSED, CLOSED, DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED |
title | string | Required within parent | Job title |
updated_at | string | Optional | Timestamp when the job was last updated Format: date-time |
work_arrangement_enum | JSON | Optional | Work arrangement of the job. Null when unspecified. |
work_arrangement_enum (anyOf 1) | string | Alternative | Work arrangement of the job. Null when unspecified. Known values: ON_SITE, HYBRID, REMOTE |
work_arrangement_enum (anyOf 2) | null | Alternative |
Referenced models: Retrieve ATS job — 200 response body — data active pause period id, paused at, Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting, Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item, Create ATS Job — 201 response body — data job employment types item, Create ATS Job — 201 response body — data job locations item, Create ATS Job — 201 response body — data job teams item, Retrieve ATS job — 200 response body — data closure reason id, name, Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY, Create ATS Job — 201 response body — data job departments Departments associated with the job item, Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at, Retrieve ATS job — 200 response body — data interview plan stages item
Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency_iso_code | string | Optional | ISO code of the currency |
id | string | Optional | Unique identifier for the compensation Format: uuid |
job_id | string | Optional | Job ID associated with the compensation Format: uuid |
max_amount | JSON | Optional | |
max_amount (anyOf 1) | JSON | Alternative | |
max_amount (anyOf 1) (anyOf 1) | number | Alternative | Maximum compensation amount Format: double |
max_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_amount (anyOf 2) | null | Alternative | Maximum compensation amount Format: double |
min_amount | JSON | Optional | |
min_amount (anyOf 1) | JSON | Alternative | |
min_amount (anyOf 1) (anyOf 1) | number | Alternative | Minimum compensation amount Format: double |
min_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_amount (anyOf 2) | null | Alternative | Minimum compensation amount Format: double |
period_slug | string | Optional | Compensation period Known values: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY |
Retrieve ATS job — 200 response body — data active pause period id, paused at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The pause currently in effect. Set only when status is PAUSED; null otherwise. |
id | string | Required within parent | Unique identifier of the pause period Format: uuid |
paused_at | string | Required within parent | When the job was paused Format: date-time |
Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Approval request for the job. Null when the job never went through approval. |
id | string | Required within parent | Unique identifier of the approval request. |
requested_at | string | Required within parent | When approval was requested. Format: date-time |
status | string | Required within parent | Current state of the approval request. PENDING and PARTIALLY_APPROVED mean approvers still have to act. Known values: PENDING, QUEUED, PARTIALLY_APPROVED, APPROVED, REJECTED, CANCELED, SKIPPED |
updated_at | string | Required within parent | When the approval request last changed. Format: date-time |
Retrieve ATS job — 200 response body — data closure reason id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Why the job was closed. Null when the job is not closed or no reason was recorded. |
id | string | Required within parent | Unique identifier of the closure reason Format: uuid |
name | string | Required within parent | Closure reason label |
Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_form_submission | string | Optional | Application form submission permissions |
application_form_submission_sensitive_fields | string | Optional | Application form submission sensitive fields permissions |
compensation | string | Optional | Compensation permissions |
hiring_team | string | Optional | Hiring team permissions |
interview_plan | string | Optional | Interview plan permissions |
job_posting | string | Optional | Job posting permissions |
Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hris_organization_user_id | string | Optional | Unique identifier for the HRIS organization user Format: uuid |
id | string | Optional | Unique identifier for the hiring member Format: uuid |
Retrieve ATS job — 200 response body — data interview plan stages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidates_count | JSON | Optional | |
candidates_count (anyOf 1) | integer | Alternative | Number of applications currently in this stage |
candidates_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category_type_slug | string | Optional | Category type of the interview plan stage Known values: LEAD, ACTIVE, COMPLETED |
default_type_slug | JSON | Optional | |
default_type_slug (anyOf 1) | string | Alternative | Default type slug of the interview plan stage |
default_type_slug (anyOf 2) | null | Alternative | Default type slug of the interview plan stage |
id | string | Optional | Unique identifier for the interview plan stage Format: uuid |
interview_plan_id | JSON | Optional | |
interview_plan_id (anyOf 1) | string | Alternative | Interview plan ID associated with this stage Format: uuid |
interview_plan_id (anyOf 2) | null | Alternative | Interview plan ID associated with this stage Format: uuid |
name | string | Optional | Customer-defined stage name |
position_number | JSON | Optional | |
position_number (anyOf 1) | JSON | Alternative | |
position_number (anyOf 1) (anyOf 1) | integer | Alternative | Position number of the stage in the interview plan |
position_number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
position_number (anyOf 2) | null | Alternative | Position number of the stage in the interview plan |
Retrieve ATS offer — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve ATS offer — 200 response body — data |
Referenced models: Retrieve ATS offer — 200 response body — data
Retrieve ATS offer — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | JSON | Optional | |
additional_details (anyOf 1) | string | Alternative | Additional details about the offer |
additional_details (anyOf 2) | null | Alternative | Additional details about the offer |
application | Model | Required within parent | Expand Retrieve ATS offer — 200 response body — data application The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all. |
application_interview_plan_stage_id | string | Optional | Application interview plan stage identifier Format: uuid |
approval_request | JSON | Required within parent | Approval request for the offer. Null when the offer never went through approval. |
approval_request (anyOf 1) | Model | Alternative | Expand Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at |
approval_request (anyOf 2) | null | Alternative | |
approval_request_id | JSON | Optional | |
approval_request_id (anyOf 1) | string | Alternative | Approval request identifier Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | Approval request identifier Format: uuid |
approval_rule_id | JSON | Optional | |
approval_rule_id (anyOf 1) | string | Alternative | Approval rule identifier Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | Approval rule identifier Format: uuid |
attachment_id | JSON | Optional | |
attachment_id (anyOf 1) | string | Alternative | Attachment identifier Format: uuid |
attachment_id (anyOf 2) | null | Alternative | Attachment identifier Format: uuid |
compensation_amount | JSON | Optional | |
compensation_amount (anyOf 1) | number | Alternative | Compensation amount Format: double |
compensation_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
compensation_currency | string | Optional | Compensation currency |
compensation_period_slug | string | Optional | Compensation period Known values: annually, monthly, semimonthly, biweekly, weekly, daily, hourly |
country_code | string | Optional | Country code Format: country-code |
created_at | string | Optional | Timestamp when the offer was created Format: date-time |
custom_fields | array | Optional | Custom fields attached to the offer |
custom_fields[] | Model | Each item | Expand Retrieve ATS offer — 200 response body — data custom fields item |
email | JSON | Optional | Email the offer was sent with. Null when the offer was never emailed. |
email (anyOf 1) | Model | Alternative | Expand Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject |
email (anyOf 2) | null | Alternative | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | string | Alternative | Date when the sent offer expires if the candidate has not responded Format: date |
expires_at (anyOf 2) | null | Alternative | Date when the sent offer expires if the candidate has not responded Format: date |
id | string | Required within parent | Unique identifier Format: uuid |
job_title | string | Optional | Job title |
offer_letter_template_id | JSON | Optional | |
offer_letter_template_id (anyOf 1) | string | Alternative | Offer letter template identifier Format: uuid |
offer_letter_template_id (anyOf 2) | null | Alternative | Offer letter template identifier Format: uuid |
offer_status | string | Required within parent | Offer status Known values: CREATED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, SENT, EXPIRED, ACCEPTED, REJECTED |
rejection_reason_id | JSON | Optional | |
rejection_reason_id (anyOf 1) | string | Alternative | Rejection reason identifier Format: uuid |
rejection_reason_id (anyOf 2) | null | Alternative | Rejection reason identifier Format: uuid |
replied_at | JSON | Optional | |
replied_at (anyOf 1) | string | Alternative | Timestamp when the candidate replied (accepted or rejected) to the offer Format: date-time |
replied_at (anyOf 2) | null | Alternative | Timestamp when the candidate replied (accepted or rejected) to the offer Format: date-time |
sent_at | JSON | Optional | |
sent_at (anyOf 1) | string | Alternative | Timestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent Format: date-time |
sent_at (anyOf 2) | null | Alternative | Timestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent Format: date-time |
start_date | string | Optional | Start date Format: date-time |
updated_at | string | Optional | Timestamp when the offer was last updated Format: date-time |
worker_type | string | Optional | Worker type Known values: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC, UNKNOWN |
Referenced models: Retrieve ATS offer — 200 response body — data application, Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at, Retrieve ATS offer — 200 response body — data custom fields item, Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject
Retrieve ATS offer — 200 response body — data application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all. |
candidate | JSON | Required within parent | The candidate who received the offer. Null once the candidate has been deleted or anonymized. |
candidate (anyOf 1) | Model | Alternative | Expand Retrieve ATS offer — 200 response body — data application candidate first name, id, last name |
candidate (anyOf 2) | null | Alternative | |
id | string | Required within parent | Application unique identifier Format: uuid |
job | Model | Required within parent | Expand Retrieve ATS offer — 200 response body — data application job The job the application belongs to. The title repeats the offer's own job_title field. |
Referenced models: Retrieve ATS offer — 200 response body — data application candidate first name, id, last name, Retrieve ATS offer — 200 response body — data application job
Retrieve ATS offer — 200 response body — data application candidate first name, id, last name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The candidate who received the offer. Null once the candidate has been deleted or anonymized. |
first_name | string | Required within parent | Candidate first name |
id | string | Required within parent | Candidate unique identifier Format: uuid |
last_name | string | Required within parent | Candidate last name |
Retrieve ATS offer — 200 response body — data application job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The job the application belongs to. The title repeats the offer's own job_title field. |
id | string | Required within parent | Job unique identifier Format: uuid |
title | string | Required within parent | Job title |
Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Approval request for the offer. Null when the offer never went through approval. |
id | string | Required within parent | Unique identifier of the approval request. |
requested_at | string | Required within parent | When approval was requested. Format: date-time |
status | string | Required within parent | Current state of the approval request. PENDING and PARTIALLY_APPROVED mean approvers still have to act. Known values: PENDING, QUEUED, PARTIALLY_APPROVED, APPROVED, REJECTED, CANCELED, SKIPPED |
updated_at | string | Required within parent | When the approval request last changed. Format: date-time |
Retrieve ATS offer — 200 response body — data custom fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom field attached to the offer |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the custom field |
description (anyOf 2) | null | Alternative | Description of the custom field |
id | string | Required within parent | Unique identifier for the custom field Format: uuid |
is_required | boolean | Required within parent | Whether the custom field is required |
name | string | Required within parent | Custom field name |
type | string | Required within parent | Type of custom field Known values: TEXT, PERCENTAGE, LIST, MULTISELECT, DATE, NUMBER, CURRENCY, HYPERLINK |
Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Email the offer was sent with. Null when the offer was never emailed. |
body_html | JSON | Optional | |
body_html (anyOf 1) | string | Alternative | Email body as HTML |
body_html (anyOf 2) | null | Alternative | Email body as HTML |
from_string | string | Required within parent | Sender, as shown in the From header |
id | string | Required within parent | Unique identifier of the email |
recipients_bcc | JSON | Optional | |
recipients_bcc (anyOf 1) | array | Alternative | Blind-carbon-copy recipients |
recipients_bcc (anyOf 1)[] | string | Each item | |
recipients_bcc (anyOf 2) | null | Alternative | Blind-carbon-copy recipients |
recipients_bcc (anyOf 2)[] | string | Each item | |
recipients_cc | JSON | Optional | |
recipients_cc (anyOf 1) | array | Alternative | Carbon-copy recipients |
recipients_cc (anyOf 1)[] | string | Each item | |
recipients_cc (anyOf 2) | null | Alternative | Carbon-copy recipients |
recipients_cc (anyOf 2)[] | string | Each item | |
recipients_to | array | Required within parent | Primary recipients |
recipients_to[] | string | Each item | |
subject | string | Required within parent | Email subject |
Retrieve a list of ATS hires — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of application-to-HRIS-profile records, ordered by updated_at ascending. |
data[] | Model | Each item | Expand Retrieve a list of ATS hires — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current one. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page; null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page; null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of hires matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a list of ATS hires — 200 response body — data item
Retrieve a list of ATS hires — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | string | Required within parent | Identifier of the ATS application that was moved to HRIS Format: uuid |
candidate_id | string | Required within parent | Identifier of the candidate the application belongs to Format: uuid |
draft_quote_id | JSON | Required within parent | |
draft_quote_id (anyOf 1) | string | Alternative | Identifier of the draft quote associated with this hire. Null when no draft quote exists. Format: uuid |
draft_quote_id (anyOf 2) | null | Alternative | Identifier of the draft quote associated with this hire. Null when no draft quote exists. Format: uuid |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Numeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet. |
hris_profile_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Numeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet. |
hris_profile_public_id | JSON | Required within parent | |
hris_profile_public_id (anyOf 1) | string | Alternative | Public (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet. Format: uuid |
hris_profile_public_id (anyOf 2) | null | Alternative | Public (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet. Format: uuid |
offer_id | string | Required within parent | Identifier of the accepted offer the hire was created from Format: uuid |
organization_id | string | Required within parent | Identifier of the organization that owns the record Format: uuid |
status_enum | string | Required within parent | State of the move to HRIS. DRAFT: a draft quote exists but no contract yet. CREATED: the HRIS profile and contract exist. DRAFT_DELETED: the draft was discarded. Known values: DRAFT, DRAFT_DELETED, CREATED |
updated_at | string | Required within parent | Timestamp of the last change to the record. Records are returned oldest change first, so the last row of a drain is a safe watermark. Format: date-time |
worker_id | JSON | Required within parent | |
worker_id (anyOf 1) | JSON | Alternative | |
worker_id (anyOf 1) (anyOf 1) | integer | Alternative | Worker identifier of the same HRIS profile. Null while the profile does not exist yet. |
worker_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker_id (anyOf 2) | null | Alternative | Worker identifier of the same HRIS profile. Null while the profile does not exist yet. |
Retrieve a list of ATS job boards — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated list of job boards with cursor-based pagination |
data | array | Required within parent | Page of job boards |
data[] | Model | Each item | Expand Retrieve a list of ATS job boards — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more job boards to fetch |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page of results |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of job boards available |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a list of ATS job boards — 200 response body — data item
Retrieve a list of ATS job boards — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board with type, status, settings, and associated career page configuration if applicable |
career_page_setting | JSON | Optional | Career page settings associated with the job board |
career_page_setting (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board |
career_page_setting (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the job board was created Format: date-time |
id | string | Required within parent | Job board unique identifier Format: uuid |
settings_json | JSON | Required within parent | Job board specific settings |
settings_json (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings |
settings_json (anyOf 2) | null | Alternative | |
status_enum | string | Required within parent | Current status of the job board Known values: ENABLED, DISABLED, ARCHIVED |
type_enum | string | Required within parent | Type of the job board Known values: INTERNAL_CAREER_PAGE, EXTERNAL_CAREER_PAGE, LINKEDIN |
updated_at | string | Required within parent | Timestamp when the job board was last updated Format: date-time |
Referenced models: Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings, Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board
Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Career page settings associated with the job board |
banner_image_url | JSON | Required within parent | |
banner_image_url (anyOf 1) | string | Alternative | URL for the banner image |
banner_image_url (anyOf 2) | null | Alternative | URL for the banner image |
dark_mode_color_primary_hexcode | JSON | Required within parent | |
dark_mode_color_primary_hexcode (anyOf 1) | string | Alternative | Primary color hex code for dark mode |
dark_mode_color_primary_hexcode (anyOf 2) | null | Alternative | Primary color hex code for dark mode |
dark_mode_logo_url | JSON | Required within parent | |
dark_mode_logo_url (anyOf 1) | string | Alternative | URL for the logo in dark mode |
dark_mode_logo_url (anyOf 2) | null | Alternative | URL for the logo in dark mode |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description displayed on the career page |
description (anyOf 2) | null | Alternative | Description displayed on the career page |
id | string | Required within parent | Career page setting unique identifier Format: uuid |
is_primary | boolean | Required within parent | Whether this is the primary career page setting |
light_mode_color_primary_hexcode | JSON | Required within parent | |
light_mode_color_primary_hexcode (anyOf 1) | string | Alternative | Primary color hex code for light mode |
light_mode_color_primary_hexcode (anyOf 2) | null | Alternative | Primary color hex code for light mode |
light_mode_logo_url | JSON | Required within parent | |
light_mode_logo_url (anyOf 1) | string | Alternative | URL for the logo in light mode |
light_mode_logo_url (anyOf 2) | null | Alternative | URL for the logo in light mode |
organization_id | string | Required within parent | Organization unique identifier Format: uuid |
preferred_organization_name | string | Required within parent | Display name for the organization on the career page |
should_show_banner_on_job_details_page | boolean | Required within parent | Whether to show the banner on job details page |
should_show_job_filters | boolean | Required within parent | Whether to show job filtering options |
should_show_logo | boolean | Required within parent | Whether to show the organization logo |
title | JSON | Required within parent | |
title (anyOf 1) | string | Alternative | Title displayed on the career page |
title (anyOf 2) | null | Alternative | Title displayed on the career page |
url_slug | string | Required within parent | URL slug for the career page |
Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board specific settings |
company_id | string | Optional | Company ID for external job boards (e.g., LinkedIn) |
Retrieve a list of ATS teams — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of resources. |
data[] | Model | Each item | Expand Retrieve a list of ATS teams — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more teams available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for pagination to get the next set of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for pagination to get the next set of results |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of teams available Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a list of ATS teams — 200 response body — data item
Retrieve a list of ATS teams — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | Timestamp when the team was archived; null while the team is active and selectable Format: date-time |
archived_at (anyOf 2) | null | Alternative | Timestamp when the team was archived; null while the team is active and selectable Format: date-time |
created_at | string | Required within parent | Timestamp when the team was created Format: date-time |
department_teams | array | Required within parent | Array of department-team relationships |
department_teams[] | Model | Each item | Expand Retrieve a list of ATS teams — 200 response body — data item department teams item |
id | string | Required within parent | Unique identifier for the team Format: uuid |
name | string | Required within parent | Name of the team |
organization_id | string | Required within parent | Unique identifier for the organization Format: uuid |
richtext_description | string | Optional | Rich text description of the team |
updated_at | string | Required within parent | Timestamp when the team was last updated Format: date-time |
Referenced models: Retrieve a list of ATS teams — 200 response body — data item department teams item
Retrieve a list of ATS teams — 200 response body — data item department teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | Model | Required within parent | Expand Retrieve a list of ATS teams — 200 response body — data item department teams item department |
id | string | Required within parent | Unique identifier for the department-team relationship Format: uuid |
Referenced models: Retrieve a list of ATS teams — 200 response body — data item department teams item department
Retrieve a list of ATS teams — 200 response body — data item department teams item department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the department Format: uuid |
name | string | Required within parent | Name of the department |
Retrieve an ATS candidate — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve an ATS candidate — 200 response body — data Candidate detail. |
Referenced models: Retrieve an ATS candidate — 200 response body — data
Retrieve an ATS candidate — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate detail. |
anonymized_at | JSON | Optional | |
anonymized_at (anyOf 1) | string | Alternative | When the candidate data was anonymized. Format: date-time |
anonymized_at (anyOf 2) | null | Alternative | When the candidate data was anonymized. Format: date-time |
applications | array | Required within parent | Applications of the candidate the authenticated user may see, newest first. |
applications[] | Model | Each item | Expand Retrieve an ATS candidate — 200 response body — data applications item |
attachments | array | Required within parent | Documents attached to the candidate, newest first. |
attachments[] | Model | Each item | Expand Retrieve an ATS candidate — 200 response body — data attachments item |
candidate_tags | array | Required within parent | Tags applied to the candidate. |
candidate_tags[] | Model | Each item | Expand Retrieve an ATS candidate — 200 response body — data candidate tags item |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City the candidate currently lives in |
city (anyOf 2) | null | Alternative | City the candidate currently lives in |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
country_code (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
created_at | string | Required within parent | When the candidate was created. Format: date-time |
email | string | Required within parent | Candidate's email address. Format: email |
final_archivation_at | JSON | Optional | |
final_archivation_at (anyOf 1) | string | Alternative | When the candidate was finally archived. Format: date-time |
final_archivation_at (anyOf 2) | null | Alternative | When the candidate was finally archived. Format: date-time |
first_name | string | Required within parent | Candidate's first name. |
id | string | Required within parent | Candidate identifier. Format: uuid |
import_session_id | JSON | Optional | |
import_session_id (anyOf 1) | string | Alternative | Bulk import session the candidate came from. |
import_session_id (anyOf 2) | null | Alternative | Bulk import session the candidate came from. |
imported_id | JSON | Optional | |
imported_id (anyOf 1) | string | Alternative | External identifier from the import source. |
imported_id (anyOf 2) | null | Alternative | External identifier from the import source. |
last_name | string | Required within parent | Candidate's last name. |
linkedin_profile_url | JSON | Required within parent | |
linkedin_profile_url (anyOf 1) | string | Alternative | Candidate's LinkedIn profile URL. |
linkedin_profile_url (anyOf 2) | null | Alternative | Candidate's LinkedIn profile URL. |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Numeric identifier for the candidate. |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
origin_source_slug | JSON | Required within parent | |
origin_source_slug (anyOf 1) | string | Alternative | How the candidate first entered the ATS. |
origin_source_slug (anyOf 2) | null | Alternative | How the candidate first entered the ATS. |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Candidate's phone number. |
phone_number (anyOf 2) | null | Alternative | Candidate's phone number. |
pic_url | JSON | Required within parent | |
pic_url (anyOf 1) | string | Alternative | URL of the candidate's profile picture. |
pic_url (anyOf 2) | null | Alternative | URL of the candidate's profile picture. |
referred_by_hris_organization_user_id | JSON | Optional | |
referred_by_hris_organization_user_id (anyOf 1) | string | Alternative | Employee who referred the candidate. Format: uuid |
referred_by_hris_organization_user_id (anyOf 2) | null | Alternative | Employee who referred the candidate. Format: uuid |
updated_at | string | Required within parent | When the candidate was last updated. Format: date-time |
Referenced models: Retrieve an ATS candidate — 200 response body — data candidate tags item, Retrieve an ATS candidate — 200 response body — data applications item, Retrieve an ATS candidate — 200 response body — data attachments item
Retrieve an ATS candidate — 200 response body — data applications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An application of the candidate. |
archivation_reason_id | JSON | Required within parent | |
archivation_reason_id (anyOf 1) | string | Alternative | Reason the application was archived; null unless archived. Format: uuid |
archivation_reason_id (anyOf 2) | null | Alternative | Reason the application was archived; null unless archived. Format: uuid |
created_at | string | Required within parent | When the application was created. Format: date-time |
current_application_interview_plan_stage | JSON | Required within parent | Where the application is now. |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now |
current_application_interview_plan_stage (anyOf 2) | null | Alternative | |
hired_at | JSON | Required within parent | |
hired_at (anyOf 1) | string | Alternative | When the application reached the hired stage; null otherwise. Format: date-time |
hired_at (anyOf 2) | null | Alternative | When the application reached the hired stage; null otherwise. Format: date-time |
id | string | Required within parent | Application identifier. Format: uuid |
job | Model | Required within parent | Expand Retrieve an ATS candidate — 200 response body — data applications item job Job of the application. |
moved_to_current_stage_at | string | Required within parent | When the application entered its current stage. Format: date-time |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Application numeric identifier. |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | When the application was last updated. Format: date-time |
Referenced models: Retrieve an ATS candidate — 200 response body — data applications item job, Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now
Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where the application is now. |
id | string | Required within parent | Current application stage record. Format: uuid |
interview_plan_stage | JSON | Required within parent | The current interview plan stage. |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now interview plan stage The current interview plan stage |
interview_plan_stage (anyOf 2) | null | Alternative |
Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now interview plan stage The current interview plan stage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current interview plan stage. |
category_type_slug | string | Required within parent | Stage category: lead, active or completed. |
default_type_slug | JSON | Required within parent | |
default_type_slug (anyOf 1) | string | Alternative | System stage type (new_lead, application_review, offer, hired, archived); null for custom stages. |
default_type_slug (anyOf 2) | null | Alternative | System stage type (new_lead, application_review, offer, hired, archived); null for custom stages. |
id | string | Required within parent | Interview plan stage identifier. Format: uuid |
name | string | Required within parent | Customer-defined stage name. |
position_number | JSON | Required within parent | |
position_number (anyOf 1) | integer | Alternative | Position of the stage in the interview plan. |
position_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve an ATS candidate — 200 response body — data applications item job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job of the application. |
id | string | Required within parent | Job identifier. Format: uuid |
status | string | Required within parent | Job status. |
title | string | Required within parent | Job title. |
Retrieve an ATS candidate — 200 response body — data attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A document attached to the candidate. |
ai_summary | JSON | Required within parent | |
ai_summary (anyOf 1) | string | Alternative | AI-generated summary of the document (CVs only); null when not yet generated. |
ai_summary (anyOf 2) | null | Alternative | AI-generated summary of the document (CVs only); null when not yet generated. |
attachment_type_slug | string | Required within parent | Kind of attachment. Known values: CV, LOGO, OFFER_LETTER, OTHER |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | When the file was attached. Format: date-time |
created_at (anyOf 2) | null | Alternative | When the file was attached. Format: date-time |
file_content_type | string | Required within parent | MIME type of the file. |
file_name | string | Required within parent | Original file name. |
id | string | Required within parent | Attachment identifier (use GET /rest/ats/attachments for a download URL). Format: uuid |
Retrieve an ATS candidate — 200 response body — data candidate tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tag applied to the candidate. |
id | string | Required within parent | Candidate tag record identifier. Format: uuid |
tag | Model | Required within parent | Expand Retrieve an ATS candidate — 200 response body — data candidate tags item tag The tag. |
Referenced models: Retrieve an ATS candidate — 200 response body — data candidate tags item tag
Retrieve an ATS candidate — 200 response body — data candidate tags item tag
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The tag. |
id | string | Required within parent | Tag identifier. Format: uuid |
label | string | Required within parent | Tag label. |
Retrieve average time per interview plan stage — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Average time applications spent in each interview plan stage. |
data[] | Model | Each item | Expand Retrieve average time per interview plan stage — 200 response body — data item |
has_more | boolean | Required within parent | Always false: the result is a single aggregate page. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: the result is a single aggregate page. |
next_cursor (anyOf 2) | null | Alternative | Always null: the result is a single aggregate page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of rows in data. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve average time per interview plan stage — 200 response body — data item
Retrieve average time per interview plan stage — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
average_seconds | JSON | Required within parent | |
average_seconds (anyOf 1) | number | Alternative | Average seconds an application spent in the stage before leaving it, excluding time the job was paused Format: double |
average_seconds (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
interview_plan_stage_name | string | Required within parent | Customer-defined stage name. Stages with the same name in different interview plans are reported once. |
Retrieve average time per interview plan stage — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
job_ids | array | Optional | |
job_ids[] | string | Each item | Format: uuid |
hiring_member_hou_ids | array | Optional | |
hiring_member_hou_ids[] | string | Each item | Format: uuid |
interview_plan_ids | array | Optional | |
interview_plan_ids[] | string | Each item | Format: uuid |
department_ids | array | Optional | |
department_ids[] | string | Each item | Format: uuid |
team_ids | array | Optional | |
team_ids[] | string | Each item | Format: uuid |
employment_type_ids | array | Optional | |
employment_type_ids[] | string | Each item | Format: uuid |
location_ids | array | Optional | |
location_ids[] | string | Each item | Format: uuid |
candidate_tag_ids | array | Optional | |
candidate_tag_ids[] | string | Each item | Format: uuid |
candidate_tag_ids_operator | string | Optional | One of: ANY, ALL |
source_slugs | array | Optional | |
source_slugs[] | string | Each item | Maximum length: 50 |
job_statuses | array | Optional | |
job_statuses[] | string | Each item | One of: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, PAUSED, CLOSED, ARCHIVED |
work_arrangements | array | Optional | |
work_arrangements[] | string | Each item | One of: ON_SITE, HYBRID, REMOTE |
date_range_start | string | Optional | Format: date-time |
date_range_end | string | Optional | Format: date-time |
workspace_ids | array | Optional | |
workspace_ids[] | string | Each item | Format: uuid |
Retrieve current application counts per interview plan stage — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Current application counts per interview plan stage, ordered by stage position. |
data[] | Model | Each item | Expand Retrieve current application counts per interview plan stage — 200 response body — data item |
has_more | boolean | Required within parent | Always false: the result is a single aggregate page. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: the result is a single aggregate page. |
next_cursor (anyOf 2) | null | Alternative | Always null: the result is a single aggregate page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of rows in data. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve current application counts per interview plan stage — 200 response body — data item
Retrieve current application counts per interview plan stage — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applications_count | JSON | Required within parent | |
applications_count (anyOf 1) | integer | Alternative | Applications currently in this stage |
applications_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category_type_slug | string | Required within parent | Category of the stage Known values: LEAD, ACTIVE, COMPLETED |
default_type_slug | JSON | Optional | |
default_type_slug (anyOf 1) | string | Alternative | Built-in stage type (new_lead, application_review, offer, hired, archived); null for custom stages |
default_type_slug (anyOf 2) | null | Alternative | Built-in stage type (new_lead, application_review, offer, hired, archived); null for custom stages |
interview_plan_stage_name | string | Required within parent | Customer-defined stage name |
job_id | JSON | Required within parent | |
job_id (anyOf 1) | string | Alternative | Job the count belongs to. Set only when job_ids is passed; otherwise counts are summed across jobs and this is null. Format: uuid |
job_id (anyOf 2) | null | Alternative | Job the count belongs to. Set only when job_ids is passed; otherwise counts are summed across jobs and this is null. Format: uuid |
position_number | JSON | Required within parent | |
position_number (anyOf 1) | integer | Alternative | Position of the stage in its interview plan |
position_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve suggested ATS email templates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve suggested ATS email templates — 200 response body — data |
Referenced models: Retrieve suggested ATS email templates — 200 response body — data
Retrieve suggested ATS email templates — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequently_used | array | Required within parent | Templates the authenticated user sent most often recently, most used first. |
frequently_used[] | Model | Each item | Expand Retrieve suggested ATS email templates — 200 response body — data frequently used item |
stage_suggestions | JSON | Required within parent | Templates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from. |
stage_suggestions (anyOf 1) | Model | Alternative | Expand Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name |
stage_suggestions (anyOf 2) | null | Alternative |
Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item, Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name
Retrieve suggested ATS email templates — 200 response body — data frequently used item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email_template | Model | Required within parent | Expand Retrieve suggested ATS email templates — 200 response body — data frequently used item email template |
send_count | JSON | Required within parent | |
send_count (anyOf 1) | integer | Alternative | How many times the template was sent in the trailing window |
send_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item email template
Retrieve suggested ATS email templates — 200 response body — data frequently used item email template
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
body | string | Required within parent | Email body as HTML with ${{token}} placeholders |
id | string | Required within parent | Email template ID Format: uuid |
subject | string | Required within parent | Email subject with ${{token}} placeholders |
title | string | Required within parent | Email template title |
type | Model | Required within parent | Expand Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type Template type |
Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type
Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Template type Known values: CUSTOM, DEFAULT_APPLICATION_CONFIRMATION, DEFAULT_ARCHIVE, DEFAULT_OFFER, DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING, DEFAULT_QUESTIONNAIRE, DEFAULT_REFERRAL_CONFIRMATION, DEFAULT_DOCUMENT, DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_CANCELLED_CANDIDATE, DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS, DEFAULT_INTERVIEW_CANCELLED_RECRUITERS, DEFAULT_INTERVIEWER_ADDED, DEFAULT_INTERVIEWER_REMOVED, DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE, DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE |
Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Templates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from. |
items | array | Required within parent | Suggested templates, most used first. |
items[] | Model | Each item | Expand Retrieve suggested ATS email templates — 200 response body — data frequently used item |
stage_name | string | Required within parent | Customer-defined stage name |
Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item
Retrieve the ATS activity timeline — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of activity entries, newest first. |
data[] | Model | Each item | Expand Retrieve the ATS activity timeline — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page; null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page; null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of entries matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve the ATS activity timeline — 200 response body — data item
Retrieve the ATS activity timeline — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | JSON | Optional | |
application_id (anyOf 1) | string | Alternative | Application the change relates to, if any Format: uuid |
application_id (anyOf 2) | null | Alternative | Application the change relates to, if any Format: uuid |
candidate_id | JSON | Optional | |
candidate_id (anyOf 1) | string | Alternative | Candidate the change relates to, if any Format: uuid |
candidate_id (anyOf 2) | null | Alternative | Candidate the change relates to, if any Format: uuid |
category | string | Required within parent | Kind of record that changed Known values: JOB, OFFER, JOB_POSTING, CANDIDATE, APPLICATION, JOB_ACTIVITY, SCHEDULED_INTERVIEW, APPLICATION_ACTIVITY, OPENING, COMPENSATION, CANDIDATE_EMAIL_BLOCKLIST_ENTRY, ORGANIZATION_SETTINGS, CANDIDATE_FOLLOW_UP_REMINDER |
changes | array | Required within parent | Fields that changed. Empty for events that carry no field changes. |
changes[] | Model | Each item | Expand Retrieve the ATS activity timeline — 200 response body — data item changes item |
created_at | string | Required within parent | When the change happened Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user who made the change. Null for changes made by the system or an automation. Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user who made the change. Null for changes made by the system or an automation. Format: uuid |
id | string | Required within parent | Unique identifier of the entry Format: uuid |
job_id | JSON | Optional | |
job_id (anyOf 1) | string | Alternative | Job the change relates to, if any Format: uuid |
job_id (anyOf 2) | null | Alternative | Job the change relates to, if any Format: uuid |
loggable_entity_id | string | Required within parent | ID of the record that changed Format: uuid |
operation_type | Model | Required within parent | Expand Retrieve the ATS activity timeline — 200 response body — data item operation type What happened to the record |
Referenced models: Retrieve the ATS activity timeline — 200 response body — data item changes item, Retrieve the ATS activity timeline — 200 response body — data item operation type
Retrieve the ATS activity timeline — 200 response body — data item changes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
after | JSON | Required within parent | |
after (anyOf 1) | string | Alternative | Value after the change. Non-string values are JSON-encoded. Null when the field was cleared. |
after (anyOf 2) | null | Alternative | Value after the change. Non-string values are JSON-encoded. Null when the field was cleared. |
before | JSON | Required within parent | |
before (anyOf 1) | string | Alternative | Value before the change. Non-string values are JSON-encoded. Null when the field was not set. |
before (anyOf 2) | null | Alternative | Value before the change. Non-string values are JSON-encoded. Null when the field was not set. |
field | string | Required within parent | Name of the changed field |
Retrieve the ATS activity timeline — 200 response body — data item operation type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | What happened to the record Known values: JOB_UPDATED, JOB_HIRING_MEMBER_ADDED, JOB_HIRING_MEMBER_REMOVED, JOB_HIRING_MEMBER_UPDATED, OFFER_CREATED, OFFER_ACCEPTED, OFFER_DECLINED, OFFER_SUBMITTED_FOR_APPROVAL, OFFER_APPROVED, OFFER_APPROVAL_REJECTED, OFFER_DELETED, OFFER_UPDATED, OFFER_SENT, OFFER_RESENT, OFFER_SENT_OUTSIDE_DEEL, OFFER_RECORDED, OFFER_ACCEPTANCE_UNDONE, OFFER_DECLINE_UNDONE, JOB_POSTING_CREATED, JOB_POSTING_UPDATED, JOB_POSTING_PUBLISHED, JOB_POSTING_UNPUBLISHED, JOB_POSTING_ARCHIVED, JOB_POSTING_PUBLICATION_UPDATED, JOB_POSTING_AUDIENCE_UPDATED, COMPENSATION_CREATED, COMPENSATION_UPDATED, COMPENSATION_DELETED, CANDIDATE_DELETED, CANDIDATE_ANONYMIZED, CANDIDATE_AUTOMATICALLY_TAGGED, CANDIDATE_CREATED, CANDIDATE_AUTO_MERGED, CANDIDATE_UPDATED, CANDIDATE_LOCATION_UPDATED, APPLICATION_TRANSITIONED, APPLICATION_AUTO_TRANSITIONED, JOB_ACTIVITY_CREATED, JOB_ACTIVITY_UPDATED, JOB_ACTIVITY_DELETED, INTERVIEW_SCHEDULED, INTERVIEWER_ADDED, INTERVIEWER_REMOVED, INTERVIEW_UPDATED, INTERVIEW_CANCELLED, INTERVIEW_SLOT_REQUEST_SENT, INTERVIEW_SLOTS_SUBMITTED, INTERVIEW_MANUALLY_LOGGED, APPLICATION_EVALUATION_PARTICIPANT_ADDED, APPLICATION_EVALUATION_PARTICIPANT_REMOVED, APPLICATION_EVALUATION_FEEDBACK_SUBMITTED, APPLICATION_ACTIVITY_FEEDBACK_DISMISSED, APPLICATION_ACTIVITY_FEEDBACK_DISMISSAL_REVERTED, APPLICATION_ACTIVITY_CREATED, APPLICATION_ACTIVITY_DELETED, EMAIL_SENT, EMAIL_SCHEDULED, AUTOMATED_EMAIL_SENT, JOB_INTERVIEW_PLAN_UPDATED, OFFER_EXPIRED, OFFER_PENDING_CREATION, OPENING_CREATED, OPENING_UPDATED, OPENING_DELETED, OPENING_SUBMITTED_FOR_APPROVAL, OPENING_APPROVED, OPENING_REJECTED, APPLICATION_SOURCE_UPDATED, APPLICATION_SOURCE_CHANNEL_UPDATED, JOB_PRIVATE_NOTE_CREATED, JOB_PRIVATE_NOTE_UPDATED, JOB_PRIVATE_NOTE_DELETED, CANDIDATE_EMAIL_BLOCKLISTED, CANDIDATE_EMAIL_UNBLOCKLISTED, ORGANIZATION_SETTINGS_UPDATED, SECURITY_STATE_CHANGED, CANDIDATE_FOLLOW_UP_REMINDER_CREATED, CANDIDATE_FOLLOW_UP_REMINDER_UPDATED, CANDIDATE_FOLLOW_UP_REMINDER_COMPLETED, CANDIDATE_FOLLOW_UP_REMINDER_DELETED |
Retrieve the organization's offer settings — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve the organization's offer settings — 200 response body — data The organization's offer settings |
Referenced models: Retrieve the organization's offer settings — 200 response body — data
Retrieve the organization's offer settings — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The organization's offer settings |
approval_exempt_fields | array | Required within parent | Offer fields whose edits do not send an approved offer back to approval |
approval_exempt_fields[] | string | Each item | Offer field Known values: WORKER_TYPE, COMPENSATION_AMOUNT, COMPENSATION_CURRENCY, COMPENSATION_PERIOD_SLUG, JOB_TITLE, COUNTRY_CODE, START_DATE, EXPIRES_AT, CUSTOM_FIELDS, ADDITIONAL_DETAILS, OPENING_ID |
default_approval_rule_id | JSON | Required within parent | |
default_approval_rule_id (anyOf 1) | string | Alternative | ID of the default approval rule for offers Format: uuid |
default_approval_rule_id (anyOf 2) | null | Alternative | ID of the default approval rule for offers Format: uuid |
is_approval_required | boolean | Required within parent | Whether every offer must go through an approval |
Send an email draft to a candidate — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Send an email draft to a candidate — 201 response body — data The email sent from the draft |
Referenced models: Send an email draft to a candidate — 201 response body — data
Send an email draft to a candidate — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The email sent from the draft |
application_id | JSON | Required within parent | |
application_id (anyOf 1) | string | Alternative | The application the email is about, or null for an email about the candidate only Format: uuid |
application_id (anyOf 2) | null | Alternative | The application the email is about, or null for an email about the candidate only Format: uuid |
bcc | array | Required within parent | BCC recipients, resolved to addresses |
bcc[] | string | Each item | Format: email |
body | string | Required within parent | The rich text HTML body as sent |
candidate_id | string | Required within parent | The candidate the email was sent to Format: uuid |
cc | array | Required within parent | CC recipients, resolved to addresses |
cc[] | string | Each item | Format: email |
from | string | Required within parent | The sender the email went out as |
id | string | Required within parent | The unique identifier of the sent email, the same as the draft it was sent from Format: uuid |
sent_at | JSON | Required within parent | |
sent_at (anyOf 1) | string | Alternative | The timestamp when the email was sent Format: date-time |
sent_at (anyOf 2) | null | Alternative | The timestamp when the email was sent Format: date-time |
subject | string | Required within parent | The subject as sent |
to | array | Required within parent | Primary recipients, with dynamic recipients such as the candidate resolved to addresses |
to[] | string | Each item | Format: email |
Send an email draft to a candidate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email_draft_id | string | Required within parent | ID of the caller's own email draft to send. Sending the same draft again returns the email already sent. Format: uuid |
expected_updated_at | string | Optional | Optional precondition: the draft's updated_at as last previewed. If the draft changed since, nothing is sent and a 409 precondition_failed is returned. Format: date-time |
Set tags in bulk — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Set tags in bulk — 200 response body — data Resolved tags grouped by tag group. |
Referenced models: Set tags in bulk — 200 response body — data
Set tags in bulk — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Resolved tags grouped by tag group. |
candidate_tags | array | Optional | |
candidate_tags[] | Model | Each item | Expand Set tags in bulk — 200 response body — data job tags item |
job_tags | array | Optional | |
job_tags[] | Model | Each item | Expand Set tags in bulk — 200 response body — data job tags item |
opening_tags | array | Optional | |
opening_tags[] | Model | Each item | Expand Set tags in bulk — 200 response body — data job tags item |
Referenced models: Set tags in bulk — 200 response body — data job tags item
Set tags in bulk — 200 response body — data job tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tag_id | string | Required within parent | Unique identifier of the resolved tag. Format: uuid |
tag_name | string | Required within parent | The tag label. |
Set tags in bulk — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | At least one tag group must be provided. Include tag_id to update an existing tag label, or omit it to create or match case-insensitively. |
$ (anyOf 1) | Model | Alternative | Expand Set tags in bulk — request body — body data candidate tags |
$ (anyOf 2) | Model | Alternative | Expand Set tags in bulk — request body — body data job tags |
$ (anyOf 3) | Model | Alternative | Expand Set tags in bulk — request body — body data opening tags |
Referenced models: Set tags in bulk — request body — body data candidate tags, Set tags in bulk — request body — body data job tags, Set tags in bulk — request body — body data opening tags
Set tags in bulk — request body — body data candidate tags
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_tags | JSON | Required within parent | Any type |
Set tags in bulk — request body — body data job tags
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
job_tags | JSON | Required within parent | Any type |
Set tags in bulk — request body — body data opening tags
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
opening_tags | JSON | Required within parent | Any type |
Set the hiring team role of a person on a job — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Set the hiring team role of a person on a job — 200 response body — data The person's hiring team membership after the change |
Referenced models: Set the hiring team role of a person on a job — 200 response body — data
Set the hiring team role of a person on a job — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person's hiring team membership after the change |
hris_organization_user_id | string | Required within parent | HRIS organization user ID of the person Format: uuid |
job_id | string | Required within parent | ID of the job Format: uuid |
role_id | JSON | Required within parent | |
role_id (anyOf 1) | JSON | Alternative | |
role_id (anyOf 1) (anyOf 1) | integer | Alternative | Role the person now holds on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null when they are not on the hiring team. |
role_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
role_id (anyOf 2) | null | Alternative | Role the person now holds on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null when they are not on the hiring team. |
Set the hiring team role of a person on a job — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_role_id | integer or null | Optional | Optional precondition: the person's role_id on the job as last read, or null when they were not on the hiring team. If it changed since, nothing changes and a 409 precondition_failed is returned. |
role_id | JSON | Required within parent | Role the person should hold on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null to remove them from the hiring team. |
role_id (oneOf 1) | string | Alternative | Role the person should hold on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null to remove them from the hiring team. One of: -60000, -60005, -60002 |
role_id (oneOf 2) | null | Alternative |
Set the time of an interview — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Set the time of an interview — 200 response body — data The scheduled interview |
Referenced models: Set the time of an interview — 200 response body — data
Set the time of an interview — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled interview |
application_activity_id | string | Required within parent | ID of the interview scheduling activity of the application Format: uuid |
id | string | Required within parent | Unique identifier of the interview Format: uuid |
starts_at | JSON | Required within parent | |
starts_at (anyOf 1) | string | Alternative | Start of the interview as booked Format: date-time |
starts_at (anyOf 2) | null | Alternative | Start of the interview as booked Format: date-time |
Set the time of an interview — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_starts_at | string or null | Optional | Optional precondition: the interview's starts_at as last read, or null when it was not scheduled. If it changed since, nothing is booked and a 409 precondition_failed is returned. Format: date-time |
starts_at | string | Required within parent | Start of the interview, normally the start_time of an available slot Format: date-time |
timezone | string | Required within parent | IANA timezone of the interview, used in the invitations |
Update ATS Application — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Updated application response |
data | Model | Required within parent | Expand Update ATS Application — 200 response body — data |
Referenced models: Update ATS Application — 200 response body — data
Update ATS Application — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Application unique identifier Format: uuid |
source_slug | JSON | Required within parent | |
source_slug (anyOf 1) | string | Alternative | The application source slug in uppercase |
source_slug (anyOf 2) | null | Alternative | The application source slug in uppercase |
updated_at | string | Required within parent | Last update timestamp Format: date-time |
Update ATS Application — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_updated_at | string | Optional | Optional precondition: the application's updated_at as last read. If the application changed since, nothing is updated and a 409 precondition_failed is returned. Format: date-time |
source_slug | string | Required within parent | The application source. Accepts any active source slug of the organization, e.g. SOURCED_INTERNALLY, SOURCED_EXTERNALLY, INTERNAL_REFERRAL_AWARE, INTERNAL_REFERRAL_NOT_AWARE, EXTERNAL_CAREER_PAGE or a custom source slug (case-insensitive) |
Update ATS Candidate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string or null | Optional | City the candidate currently lives in |
country_code | string or null | Optional | ISO 3166-1 alpha-2 code of the country the candidate currently lives in |
email | string | Optional | The candidate's email address Format: email |
expected_updated_at | string | Optional | Optional precondition: the candidate's updated_at as last read. If the candidate changed since, nothing is updated and a 409 precondition_failed is returned. Does not count as a field to update. Format: date-time |
first_name | string | Optional | The candidate's first name |
last_name | string | Optional | The candidate's last name |
linkedin_profile_url | string | Optional | The candidate's LinkedIn profile URL Format: uri |
origin_source_slug | string | Optional | The candidate's origin source slug. Accepts any active source slug of the organization, e.g. sourced_internally, sourced_externally, external_career_page, linkedin_basic or a custom source slug (case-insensitive) |
phone_number | string | Optional | The candidate's phone number |
pic_url | string | Optional | The candidate's picture URL Format: uri |
Upload ATS Candidate CV — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Upload ATS Candidate CV — 201 response body — data |
Referenced models: Upload ATS Candidate CV — 201 response body — data
Upload ATS Candidate CV — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachable_id | string | Optional | Unique identifier of the entity the file is attached to Format: uuid |
attachable_type_slug | string | Required within parent | Type of the entity the file is attached to Known values: CANDIDATE |
attachment_type_slug | string | Required within parent | Type of the attachment Known values: CV, LOGO, OFFER_LETTER, OTHER |
created_at | string | Optional | Timestamp when the attachment was created Format: date-time |
file_content_type | JSON | Optional | |
file_content_type (anyOf 1) | string | Alternative | Content type of the attached file |
file_content_type (anyOf 2) | null | Alternative | Content type of the attached file |
file_name | string | Required within parent | Name of the attached file |
id | string | Required within parent | Unique identifier for the attachment Format: uuid |
updated_at | string | Optional | Timestamp when the attachment was last updated Format: date-time |
Upload an ATS attachment file — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Upload an ATS attachment file — 201 response body — data |
Referenced models: Upload an ATS attachment file — 201 response body — data
Upload an ATS attachment file — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ai_summary | JSON | Optional | |
ai_summary (anyOf 1) | string | Alternative | AI-generated summary of the attachment |
ai_summary (anyOf 2) | null | Alternative | AI-generated summary of the attachment |
attachable_id | string | Optional | Unique identifier of the entity the file is attached to Format: uuid |
attachable_type_slug | string | Required within parent | Type of the entity the file is attached to Known values: CANDIDATE, OFFER, JOB_ACTIVITY |
attachment_type_slug | string | Required within parent | Type of the attachment Known values: CV, LOGO, OFFER_LETTER, OTHER |
created_at | string | Optional | Timestamp when the attachment was created Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | User ID who created the attachment Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | User ID who created the attachment Format: uuid |
file_content_type | string | Required within parent | Content type of the attached file |
file_name | string | Required within parent | Name of the attached file |
id | string | Required within parent | Unique identifier for the attachment Format: uuid |
updated_at | string | Optional | Timestamp when the attachment was last updated Format: date-time |
Validate offer terms for an application — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Validate offer terms for an application — 200 response body — data Outcome of the validation |
Referenced models: Validate offer terms for an application — 200 response body — data
Validate offer terms for an application — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Outcome of the validation |
errors | array | Required within parent | Rules the terms break; empty when the terms are valid |
errors[] | Model | Each item | Expand Validate offer terms for an application — 200 response body — data errors item |
is_valid | boolean | Required within parent | Whether the terms satisfy every rule |
Referenced models: Validate offer terms for an application — 200 response body — data errors item
Validate offer terms for an application — 200 response body — data errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Machine-readable code of the broken rule |
field | JSON | Required within parent | |
field (anyOf 1) | string | Alternative | Request field the error is about, or null when it concerns the terms as a whole |
field (anyOf 2) | null | Alternative | Request field the error is about, or null when it concerns the terms as a whole |
message | string | Required within parent | Explanation of the broken rule to show to the user |
Validate offer terms for an application — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compensation_amount | number | Required within parent | Compensation amount for the period Format: double |
compensation_currency | string | Required within parent | ISO 4217 currency code of the compensation |
compensation_period_slug | string | Optional | Period the compensation amount covers One of: annually, monthly, semimonthly, biweekly, weekly, daily, hourly |
country_code | string | Required within parent | ISO 3166-1 alpha-2 code of the country the candidate will work in Format: country-code |
job_title | string or null | Optional | Job title offered to the candidate |
start_date | string | Required within parent | Proposed start date of the candidate Format: date-time |
state | string or null | Optional | State or region code within the country, where the rules depend on it |
worker_type | string | Required within parent | How the candidate will be hired One of: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC |