Deel: ATS applications schemas
70 Deel schemas with complete fields and constraints.
← ATS applications operations · All schemas
Add note to an application — ats Applications add Note To An Application V20261106 — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
richtext_content | string | Required within parent | The content of the note in rich text HTML format |
Add note to an application — ats Applications add Note To An Application — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add note to an application — ats Applications add Note To An Application — 201 response body — data The created application note |
Referenced models: Add note to an application — ats Applications add Note To An Application — 201 response body — data
Add note to an application — ats Applications add Note To An Application — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created application note |
created_at | string | Required within parent | The timestamp when the application note was created Format: date-time |
id | string | Required within parent | The unique identifier of the application note Format: uuid |
updated_at | string | Required within parent | The timestamp when the application note was last updated Format: date-time |
Add note to an application — ats Applications add Note To An Application — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
author_id | string | Required within parent | The UUID of the HRIS organization user creating the note Format: uuid |
richtext_content | string | Required within parent | The content of the note in rich text HTML format |
Assign application to interview plan stage — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Assign application to interview plan stage — 201 response body — data The created application interview plan stage record |
Referenced models: Assign application to interview plan stage — 201 response body — data
Assign application to interview plan stage — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created application interview plan stage record |
created_at | string | Required within parent | The timestamp when the record was created Format: date-time |
id | string | Required within parent | The unique identifier of the created application interview plan stage record Format: uuid |
updated_at | string | Required within parent | The timestamp when the record was last updated Format: date-time |
Assign application to interview plan stage — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicable_job_activities | array | Optional | Optional array of job activities to trigger when associating the application with this stage. If not provided, all activities will be triggered. If an empty array is provided, no activities will be triggered. |
applicable_job_activities[] | Model | Each item | Expand Assign application to interview plan stage — request body — body data applicable job activities item |
candidate_archivation_email_template_id | string | Optional | Optional ID of the rejection email template if the candidate is being archived Format: uuid |
candidate_archivation_reason_id | string | Optional | Optional ID of the archivation reason if the candidate is being archived Format: uuid |
creator_id | string | Optional | Ignored. The move is always recorded as made by the calling user, service accounts included. Format: uuid |
delay_amount | integer | Optional | The amount of time to delay the archivation email. Must be provided together with delay_unit. Cannot be used together with scheduled_send_at. Maximum: 100 Minimum: 1 |
delay_unit | string | Optional | The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at. One of: hours, days, weeks |
expected_current_interview_plan_stage_id | string | Optional | Optional precondition: the application's current interview plan stage ID as last read. If the application has moved since, nothing changes and a 409 precondition_failed is returned. Format: uuid |
interview_plan_stage_id | string | Required within parent | The ID of the interview plan stage to associate with the application Format: uuid |
is_current_stage | boolean | Required within parent | When true, sets this stage as the application's current stage in the hiring workflow. When false, creates a historical record without changing the application's current stage. |
scheduled_send_at | string | Optional | The exact future datetime to send the archivation email. Cannot be used together with delay_amount/delay_unit. Format: date-time |
Referenced models: Assign application to interview plan stage — request body — body data applicable job activities item
Assign application to interview plan stage — request body — body data applicable job activities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_self_scheduling_email_template_id | string | Optional | Optional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities) Format: uuid |
id | string | Required within parent | The ID of the job activity to trigger Format: uuid |
participants | array | Optional | Optional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used. |
participants[] | Model | Each item | Expand Create a stage move for an application — request body — body data applicable job activities item participants item |
Referenced models: Create a stage move for an application — request body — body data applicable job activities item participants item
Create ATS Application — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Created application response |
data | Model | Required within parent | Expand Create ATS Application — 201 response body — data |
Referenced models: Create ATS Application — 201 response body — data
Create ATS Application — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_id | string | Required within parent | Candidate unique identifier Format: uuid |
created_at | string | Required within parent | Creation timestamp Format: date-time |
current_application_interview_plan_stage_id | JSON | Required within parent | |
current_application_interview_plan_stage_id (anyOf 1) | string | Alternative | Current interview plan stage identifier Format: uuid |
current_application_interview_plan_stage_id (anyOf 2) | null | Alternative | Current interview plan stage identifier Format: uuid |
id | string | Required within parent | Application unique identifier Format: uuid |
job_employment_type_id | JSON | Required within parent | |
job_employment_type_id (anyOf 1) | string | Alternative | Job employment type identifier Format: uuid |
job_employment_type_id (anyOf 2) | null | Alternative | Job employment type identifier Format: uuid |
job_id | string | Required within parent | Job unique identifier Format: uuid |
job_posting_id | JSON | Required within parent | |
job_posting_id (anyOf 1) | string | Alternative | Job posting unique identifier Format: uuid |
job_posting_id (anyOf 2) | null | Alternative | Job posting unique identifier Format: uuid |
moved_to_current_stage_at | JSON | Required within parent | |
moved_to_current_stage_at (anyOf 1) | string | Alternative | When application moved to current stage Format: date-time |
moved_to_current_stage_at (anyOf 2) | null | Alternative | When application moved to 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]+)?$ |
source_slug | JSON | Optional | |
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 |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_city | string | Required within parent | City |
address_country | string | Required within parent | Country |
address_number | string | Required within parent | Street number |
address_state | string | Required within parent | State |
address_street | string | Required within parent | Street name |
address_zip_code | string | Required within parent | ZIP code |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: ADDRESS |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
question_id | string | Required within parent | Question identifier |
selected_option_ids | array | Required within parent | Selected option IDs |
selected_option_ids[] | string | Each item | |
type | string | Required within parent | Question type this answer belongs to. One of: CUSTOMDROPDOWN |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Optional | End date (for ranges) |
question_id | string | Required within parent | Question identifier |
start_date | string | Optional | Start date |
type | string | Required within parent | Question type this answer belongs to. One of: DATEPICKER |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_ids | array | Required within parent | Document IDs |
document_ids[] | string | Each item | |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: DOCUMENTUPLOAD |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | Email address Format: email |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: EMAIL |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | string | Required within parent | Text answer |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: FREETEXT |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
question_id | string | Required within parent | Question identifier |
selected_option_ids | array | Required within parent | Selected option IDs |
selected_option_ids[] | string | Each item | |
type | string | Required within parent | Question type this answer belongs to. One of: MULTISELECTION |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: NUMBER |
value | string | Required within parent | Numeric value |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | string | Required within parent | Paragraph answer |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: PARAGRAPH |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
phone_number | string | Required within parent | Phone number |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: PHONENUMBER |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
preset | string | Required within parent | Preset name |
question_id | string | Required within parent | Question identifier |
selected_options | array | Required within parent | Selected options |
selected_options[] | string | Each item | |
type | string | Required within parent | Question type this answer belongs to. One of: PRESETDROPDOWN |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
question_id | string | Required within parent | Question identifier |
selected_option_id | string | Required within parent | Selected option ID |
type | string | Required within parent | Question type this answer belongs to. One of: SINGLESELECTION |
Create ATS Application — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_form_submission_data | array or null | Optional | Array of form submission answers |
application_form_submission_data[] | Model | Each item | Expand Create ATS Application — request body — body data application form submission data item |
candidate_id | string | Required within parent | The ID of the candidate applying Format: uuid |
job_employment_type_id | string | Required within parent | The ID of the employment type for this job Format: uuid |
job_id | string | Required within parent | The ID of the job for this application Format: uuid |
job_posting_id | string or null | Optional | The ID of the job posting (optional) Format: uuid |
notes | array or null | Optional | Array of notes to attach to the application |
notes[] | Model | Each item | Expand Create ATS Application — request body — body data notes item |
source_slug | string | Optional | 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). Defaults to the candidate origin source when omitted. |
Referenced models: Create ATS Application — request body — body data application form submission data item, Create ATS Application — request body — body data notes item
Create ATS Application — request body — body data application form submission data item
Referenced models: Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL, Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION, Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION, Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN, Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN, Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS
Create ATS Application — request body — body data notes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
richtext_content | string | Required within parent | The richtext content of the note |
Retrieve ATS application — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Single application response |
data | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data Complete application details |
Referenced models: Retrieve ATS application — 200 response body — data
Retrieve ATS application — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete application details |
all_application_interview_plan_stages | array | Required within parent | All interview plan stages |
all_application_interview_plan_stages[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item |
application_automation_rule_executions | array | Required within parent | Automation rule executions |
application_automation_rule_executions[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data application automation rule executions item |
application_form_submission | JSON | Optional | Application form submission data with mapped answers |
application_form_submission (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data application form submission answers, id |
application_form_submission (anyOf 2) | null | Alternative | |
application_job_criterias_matchings | array | Required within parent | Job criteria matchings |
application_job_criterias_matchings[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data application job criterias matchings item |
archivation_reason | JSON | Required within parent | Archivation reason details; null unless archived |
archivation_reason (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived |
archivation_reason (anyOf 2) | null | Alternative | |
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 |
candidate | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data candidate Candidate details |
created_at | string | Required within parent | Timestamp when the application was created Format: date-time |
created_by | JSON | Required within parent | |
created_by (anyOf 1) | string | Alternative | Unique identifier for the HRIS organization user who created the application Format: uuid |
created_by (anyOf 2) | null | Alternative | Unique identifier for the HRIS organization user who created the application Format: uuid |
current_application_interview_plan_stage | JSON | Required within parent | Current interview plan stage for the application |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application |
current_application_interview_plan_stage (anyOf 2) | null | Alternative | |
hired_at | JSON | Required within parent | |
hired_at (anyOf 1) | string | Alternative | Timestamp when the application reached the hired stage; null otherwise Format: date-time |
hired_at (anyOf 2) | null | Alternative | Timestamp when the application reached the hired stage; null otherwise Format: date-time |
id | string | Required within parent | Unique identifier for the application Format: uuid |
job | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data job Job details |
job_board | JSON | Required within parent | Job board where application originated |
job_board (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data / job_board / type: INTERNAL CAREER PAGE, EXTERNAL CAREER PAGE, LINKEDIN |
job_board (anyOf 2) | null | Alternative | |
job_employment_type | JSON | Required within parent | Employment type associated with the application |
job_employment_type (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application |
job_employment_type (anyOf 2) | null | Alternative | |
job_posting | JSON | Required within parent | Job posting details |
job_posting (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data job posting Job posting details |
job_posting (anyOf 2) | null | Alternative | |
job_posting_publication | JSON | Required within parent | Job posting publication details |
job_posting_publication (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data job posting publication Job posting publication details |
job_posting_publication (anyOf 2) | null | Alternative | |
job_posting_publication_state | JSON | Required within parent | Current state of job posting publication |
job_posting_publication_state (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data job posting publication state Current state of job posting publication |
job_posting_publication_state (anyOf 2) | null | Alternative | |
moved_to_current_stage_at | string | Required within parent | Timestamp when the application moved to the current stage Format: date-time |
notes | array | Required within parent | Notes on application |
notes[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data notes item |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Numeric identifier for the application |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referral_form_submission | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data referral form submission Referral form submission metadata |
referred_by | JSON | Required within parent | |
referred_by (anyOf 1) | string | Alternative | Unique identifier for the HRIS organization user who referred the candidate Format: uuid |
referred_by (anyOf 2) | null | Alternative | Unique identifier for the HRIS organization user who referred the candidate Format: uuid |
source_channel_campaign_slug | JSON | Required within parent | |
source_channel_campaign_slug (anyOf 1) | string | Alternative | Hiring campaign of the source channel the application came through; null when none |
source_channel_campaign_slug (anyOf 2) | null | Alternative | Hiring campaign of the source channel the application came through; null when none |
source_channel_medium_slug | JSON | Required within parent | |
source_channel_medium_slug (anyOf 1) | string | Alternative | Kind of placement of the source channel the application came through; null when none |
source_channel_medium_slug (anyOf 2) | null | Alternative | Kind of placement of the source channel the application came through; null when none |
source_channel_name | JSON | Required within parent | |
source_channel_name (anyOf 1) | string | Alternative | Where the candidate clicked: the source channel of the source channel the application came through; null when none |
source_channel_name (anyOf 2) | null | Alternative | Where the candidate clicked: the source channel of the source channel the application came through; null when none |
source_slug | JSON | Required within parent | |
source_slug (anyOf 1) | string | Alternative | Source slug |
source_slug (anyOf 2) | null | Alternative | Source slug |
submitter_ip_address | JSON | Optional | |
submitter_ip_address (anyOf 1) | string | Alternative | IP address of the applicant who submitted the application |
submitter_ip_address (anyOf 2) | null | Alternative | IP address of the applicant who submitted the application |
submitter_user_agent | JSON | Optional | |
submitter_user_agent (anyOf 1) | string | Alternative | User agent of the applicant who submitted the application |
submitter_user_agent (anyOf 2) | null | Alternative | User agent of the applicant who submitted the application |
updated_at | string | Required within parent | Timestamp when the application was last updated Format: date-time |
Referenced models: Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived, Retrieve ATS application — 200 response body — data job, Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application, Retrieve ATS application — 200 response body — data job posting Job posting details, Retrieve ATS application — 200 response body — data job posting publication Job posting publication details, Retrieve ATS application — 200 response body — data notes item, Retrieve ATS application — 200 response body — data all application interview plan stages item, Retrieve ATS application — 200 response body — data application automation rule executions item, Retrieve ATS application — 200 response body — data application form submission answers, id, Retrieve ATS application — 200 response body — data application job criterias matchings item, Retrieve ATS application — 200 response body — data candidate, Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application, Retrieve ATS application — 200 response body — data / job_board / type: INTERNAL CAREER PAGE, EXTERNAL CAREER PAGE, LINKEDIN, Retrieve ATS application — 200 response body — data job posting publication state Current state of job posting publication, Retrieve ATS application — 200 response body — data referral form submission
Retrieve ATS application — 200 response body — data / job_board / type: INTERNAL CAREER PAGE, EXTERNAL CAREER PAGE, LINKEDIN
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board where application originated |
id | string | Required within parent | Job board unique identifier Format: uuid |
type | string | Required within parent | Type of job board Known values: INTERNAL_CAREER_PAGE, EXTERNAL_CAREER_PAGE, LINKEDIN |
Retrieve ATS application — 200 response body — data all application interview plan stages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entered_at | string | Required within parent | Timestamp when the application entered this stage Format: date-time |
exited_at | JSON | Required within parent | |
exited_at (anyOf 1) | string | Alternative | Timestamp when the application left this stage; null while the application is still in it Format: date-time |
exited_at (anyOf 2) | null | Alternative | Timestamp when the application left this stage; null while the application is still in it Format: date-time |
id | string | Required within parent | Unique identifier for the application interview plan stage Format: uuid |
interview_plan_stage | JSON | Required within parent | |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number |
interview_plan_stage (anyOf 2) | null | Alternative | |
is_current | boolean | Required within parent | Whether this is the stage the application is currently in |
moved_by_hris_organization_user_id | JSON | Required within parent | |
moved_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user who moved the application into this stage; null for automated moves Format: uuid |
moved_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user who moved the application into this stage; null for automated moves Format: uuid |
offers | array | Required within parent | Array of offers associated with this stage |
offers[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item offers item |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Timestamp when the stage was last updated Format: date-time |
updated_at (anyOf 2) | null | Alternative | Timestamp when the stage was last updated Format: date-time |
Referenced models: Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number, Retrieve ATS application — 200 response body — data all application interview plan stages item offers item
Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_type_slug | string | Required within parent | Category type slug |
default_type_slug | JSON | Required within parent | |
default_type_slug (anyOf 1) | string | Alternative | Default type slug |
default_type_slug (anyOf 2) | null | Alternative | Default type slug |
id | string | Required within parent | Interview plan stage unique identifier Format: uuid |
name | string | Required within parent | Interview plan 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 ATS application — 200 response body — data all application interview plan stages item offers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Offer details |
application_interview_plan_stage_id | string | Required within parent | Unique identifier for the application interview plan stage Format: uuid |
approval_request_id | JSON | Required within parent | |
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 | Required within parent | |
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 |
attachment_id | JSON | Required within parent | |
attachment_id (anyOf 1) | string | Alternative | Unique identifier for the offer attachment Format: uuid |
attachment_id (anyOf 2) | null | Alternative | Unique identifier for the offer attachment Format: uuid |
compensation_amount | JSON | Required within parent | |
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 | Required within parent | Currency code for compensation (ISO 4217) |
compensation_period_slug | JSON | Required within parent | Compensation period |
compensation_period_slug (anyOf 1) | string | Alternative | Compensation period Known values: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY |
compensation_period_slug (anyOf 2) | null | Alternative | |
country_code | string | Required within parent | Country code (ISO 3166-1 alpha-2) |
created_at | string | Required within parent | Timestamp when the offer was created Format: date-time |
email | JSON | Optional | Email message associated with the offer |
email (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item offers item email Email message associated with the offer |
email (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the offer Format: uuid |
job_title | string | Required within parent | Job title for the offer |
offer_status_enum | string | Required within parent | Status of the offer Known values: CREATED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, SENT, EXPIRED, ACCEPTED, REJECTED |
rejection_reason_id | JSON | Required within parent | |
rejection_reason_id (anyOf 1) | string | Alternative | Unique identifier for the rejection reason (if rejected) Format: uuid |
rejection_reason_id (anyOf 2) | null | Alternative | Unique identifier for the rejection reason (if rejected) Format: uuid |
start_date | string | Required within parent | Start date for the position Format: date-time |
updated_at | string | Required within parent | Timestamp when the offer was last updated Format: date-time |
worker_type_enum | string | Required within parent | Type of worker for the offer Known values: CONTRACTOR, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, UNKNOWN |
Referenced models: Retrieve ATS application — 200 response body — data all application interview plan stages item offers item email Email message associated with the offer
Retrieve ATS application — 200 response body — data all application interview plan stages item offers item email Email message associated with the offer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Email message associated with the offer |
body_html | string | Required within parent | HTML body of the email |
from_string | string | Required within parent | Email sender address |
id | string | Required within parent | Unique identifier for the email message Format: uuid |
recipients_bcc | array | Required within parent | Array of BCC recipient email addresses |
recipients_bcc[] | string | Each item | |
recipients_cc | array | Required within parent | Array of CC recipient email addresses |
recipients_cc[] | string | Each item | |
recipients_to | array | Required within parent | Array of recipient email addresses |
recipients_to[] | string | Each item | |
subject | string | Required within parent | Email subject line |
Retrieve ATS application — 200 response body — data application automation rule executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application automation rule execution |
action_type_enum | string | Required within parent | Type of action to execute Known values: ADD_CANDIDATE_TAG, TRANSITION_APPLICATION |
application_automation_rule_id | string | Required within parent | Automation rule identifier Format: uuid |
evaluation_result | array | Required within parent | Array of evaluation results |
evaluation_result[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item |
id | string | Required within parent | Unique identifier for the automation rule execution Format: uuid |
Referenced models: Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item
Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Evaluation result for automation rule |
comparison_value | string | Required within parent | Value to compare against |
form_builder_question_data_binding_id | string | Required within parent | Form builder question data binding identifier |
group_id | JSON | Required within parent | |
group_id (anyOf 1) | integer | Alternative | Group identifier for the condition |
group_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique identifier for the evaluation result Format: uuid |
is_condition_met | boolean | Required within parent | Whether the condition is met |
operator_enum | string | Required within parent | Comparison operator Known values: EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, IS_EMPTY, IS_NOT_EMPTY, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL |
Retrieve ATS application — 200 response body — data application form submission answers, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application form submission data with mapped answers |
answers | array | Required within parent | Array of question answers with parsed data |
answers[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data application form submission answers, id answers item |
id | string | Required within parent | Identifier of the application form submission Format: uuid |
Referenced models: Retrieve ATS application — 200 response body — data application form submission answers, id answers item
Retrieve ATS application — 200 response body — data application form submission answers, id answers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Form submission answer |
answer | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data application form submission answers, id answers item answer The answer value |
data_binding_id | string | Required within parent | Data binding identifier for the question |
question_text | string | Required within parent | Text of the question |
question_type | string | Required within parent | Type of the question (uppercase) Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, DOCUMENTUPLOAD, PRESETDROPDOWN, CUSTOMDROPDOWN, NUMBER, DATEPICKER, ADDRESS, PHONENUMBER, EMAIL |
Referenced models: Retrieve ATS application — 200 response body — data application form submission answers, id answers item answer
Retrieve ATS application — 200 response body — data application form submission answers, id answers item answer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The answer value |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve ATS application — 200 response body — data application job criterias matchings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Match description |
id | string | Required within parent | Job criteria matching identifier Format: uuid |
is_matched | string | Required within parent | Match status Known values: MATCHED, NOT_MATCHED, UNDECIDED |
job_criteria | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria |
Referenced models: Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria
Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Job criteria description |
id | string | Required within parent | Job criteria identifier Format: uuid |
title | string | Required within parent | Job criteria title |
Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Archivation reason details; null unless archived |
id | string | Required within parent | Archivation reason identifier Format: uuid |
label | string | Required within parent | Archivation reason label |
Retrieve ATS application — 200 response body — data candidate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate details |
attachments | array | Required within parent | Array of attachments associated with the candidate (e.g., resume, cover letter) |
attachments[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data candidate attachments item |
candidate_tags | array | Required within parent | Tags associated with the candidate |
candidate_tags[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data candidate candidate tags item |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | Candidate city |
city (anyOf 2) | null | Alternative | Candidate city |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | Candidate country code (ISO 3166-1 alpha-2) |
country_code (anyOf 2) | null | Alternative | Candidate country code (ISO 3166-1 alpha-2) |
email | string | Required within parent | Candidate email address Format: email |
first_name | string | Required within parent | Candidate first name |
id | string | Required within parent | Candidate unique identifier Format: uuid |
import_session_id | JSON | Required within parent | |
import_session_id (anyOf 1) | string | Alternative | Import session identifier if bulk imported |
import_session_id (anyOf 2) | null | Alternative | Import session identifier if bulk imported |
last_name | string | Required within parent | Candidate last name |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Candidate phone number |
phone_number (anyOf 2) | null | Alternative | Candidate phone number |
profile_picture_url | JSON | Required within parent | |
profile_picture_url (anyOf 1) | string | Alternative | Candidate profile picture URL |
profile_picture_url (anyOf 2) | null | Alternative | Candidate profile picture URL |
Referenced models: Retrieve ATS application — 200 response body — data candidate candidate tags item, Retrieve ATS application — 200 response body — data candidate attachments item
Retrieve ATS application — 200 response body — data candidate attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ai_summary | JSON | Required within parent | |
ai_summary (anyOf 1) | string | Alternative | AI-generated summary of the attachment content |
ai_summary (anyOf 2) | null | Alternative | AI-generated summary of the attachment content |
id | string | Required within parent | Unique identifier for the attachment Format: uuid |
Retrieve ATS application — 200 response body — data candidate candidate tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate tag |
id | string | Required within parent | Unique identifier for the candidate tag Format: uuid |
tag | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data candidate candidate tags item tag Tag details |
Referenced models: Retrieve ATS application — 200 response body — data candidate candidate tags item tag
Retrieve ATS application — 200 response body — data candidate candidate tags item tag
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tag details |
id | string | Required within parent | Unique identifier for the tag Format: uuid |
label | string | Required within parent | Label of the tag |
Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current interview plan stage for the application |
id | string | Required within parent | Identifier of the application interview plan stage record Format: uuid |
interview_plan_stage | JSON | Required within parent | |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number |
interview_plan_stage (anyOf 2) | null | Alternative |
Retrieve ATS application — 200 response body — data job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job details |
id | string | Required within parent | Unique identifier for the job Format: uuid |
title | string | Required within parent | Title of the job |
Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type associated with the application |
employment_type | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type Employment type metadata |
id | string | Required within parent | Identifier of the job employment type record Format: uuid |
Referenced models: Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type
Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type metadata |
id | string | Required within parent | Identifier of the employment type Format: uuid |
name | string | Required within parent | Human readable employment type |
Retrieve ATS application — 200 response body — data job posting Job posting details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting details |
id | string | Required within parent | Unique identifier for the job posting Format: uuid |
title | string | Required within parent | Title of the job posting |
Retrieve ATS application — 200 response body — data job posting publication Job posting publication details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting publication details |
id | string | Required within parent | Job posting publication unique identifier Format: uuid |
Retrieve ATS application — 200 response body — data job posting publication state Current state of job posting publication
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current state of job posting publication |
id | string | Required within parent | Job posting publication state identifier Format: uuid |
state_slug | string | Required within parent | State of job posting publication Known values: PUBLISHED_BASIC, PUBLISHED_PREMIUM, UNPUBLISHED, EXPIRED, IN_PROGRESS, FAILED |
Retrieve ATS application — 200 response body — data notes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Note associated with the application |
created_at | string | Required within parent | Timestamp when the note was created Format: date-time |
created_by | string | Required within parent | Unique identifier for the user who created the note Format: uuid |
id | string | Required within parent | Unique identifier for the note Format: uuid |
richtext_content | string | Required within parent | Rich text content of the note |
updated_at | string | Required within parent | Timestamp when the note was last updated Format: date-time |
Retrieve ATS application — 200 response body — data referral form submission
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Referral form submission metadata |
form_builder_stringified | JSON | Required within parent | |
form_builder_stringified (anyOf 1) | string | Alternative | Stringified JSON data for the referral form submission |
form_builder_stringified (anyOf 2) | null | Alternative | Stringified JSON data for the referral form submission |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Identifier of the referral form submission Format: uuid |
id (anyOf 2) | null | Alternative | Identifier of the referral form submission Format: uuid |
Retrieve a list of ATS applications — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated list of applications |
data | array | Required within parent | Page of applications |
data[] | Model | Each item | Expand Retrieve a list of ATS applications — 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 applications |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item
Retrieve a list of ATS applications — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application object |
application_form_form_builder_form_submission_id | JSON | Optional | |
application_form_form_builder_form_submission_id (anyOf 1) | string | Alternative | Application form submission unique identifier Format: uuid |
application_form_form_builder_form_submission_id (anyOf 2) | null | Alternative | Application form submission unique identifier Format: uuid |
application_form_submission | JSON | Optional | Application form submission data with parsed answers |
application_form_submission (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id |
application_form_submission (anyOf 2) | null | Alternative | |
application_job_criterias_matchings | array | Optional | AI-generated job criteria matching results for the application |
application_job_criterias_matchings[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item |
archivation_reason_id | JSON | Optional | |
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 |
candidate | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item candidate Candidate information associated with the application |
created_at | string | Required within parent | Timestamp of when the application was created Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | User who created the application Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | User who created the application Format: uuid |
current_application_interview_plan_stage | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage Current interview plan stage information for the application |
current_application_interview_plan_stage_id | JSON | Optional | |
current_application_interview_plan_stage_id (anyOf 1) | string | Alternative | Current interview plan stage unique identifier Format: uuid |
current_application_interview_plan_stage_id (anyOf 2) | null | Alternative | Current interview plan stage unique identifier Format: uuid |
hired_at | JSON | Optional | |
hired_at (anyOf 1) | string | Alternative | Timestamp when the application reached the hired stage; null otherwise Format: date-time |
hired_at (anyOf 2) | null | Alternative | Timestamp when the application reached the hired stage; null otherwise Format: date-time |
id | string | Required within parent | Application unique identifier Format: uuid |
job | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item job Job information for the application |
job_employment_type | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item job employment type Employment type information for the job |
job_posting | JSON | Optional | Job posting information (if application came through a posting) |
job_posting (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS applications — 200 response body — data item job posting id, title |
job_posting (anyOf 2) | null | Alternative | |
moved_to_current_stage_at | string | Required within parent | Timestamp of when the application moved to 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]+)?$ |
source_channel_campaign_slug | JSON | Optional | |
source_channel_campaign_slug (anyOf 1) | string | Alternative | Hiring campaign of the source channel the application came through; null when none |
source_channel_campaign_slug (anyOf 2) | null | Alternative | Hiring campaign of the source channel the application came through; null when none |
source_channel_medium_slug | JSON | Optional | |
source_channel_medium_slug (anyOf 1) | string | Alternative | Kind of placement of the source channel the application came through; null when none |
source_channel_medium_slug (anyOf 2) | null | Alternative | Kind of placement of the source channel the application came through; null when none |
source_channel_name | JSON | Optional | |
source_channel_name (anyOf 1) | string | Alternative | Where the candidate clicked: the source channel of the source channel the application came through; null when none |
source_channel_name (anyOf 2) | null | Alternative | Where the candidate clicked: the source channel of the source channel the application came through; null when none |
source_slug | JSON | Optional | |
source_slug (anyOf 1) | string | Alternative | Source of the application |
source_slug (anyOf 2) | null | Alternative | Source of the application |
stage_history | array | Optional | Chronological stage timeline of the application. Present only when include=STAGE_HISTORY is requested. |
stage_history[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item stage history item |
submitter_ip_address | JSON | Optional | |
submitter_ip_address (anyOf 1) | string | Alternative | IP address of the applicant who submitted the application |
submitter_ip_address (anyOf 2) | null | Alternative | IP address of the applicant who submitted the application |
submitter_user_agent | JSON | Optional | |
submitter_user_agent (anyOf 1) | string | Alternative | User agent of the applicant who submitted the application |
submitter_user_agent (anyOf 2) | null | Alternative | User agent of the applicant who submitted the application |
updated_at | string | Optional | Timestamp of when the application was last updated Format: date-time |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item job, Retrieve a list of ATS applications — 200 response body — data item job employment type, Retrieve a list of ATS applications — 200 response body — data item job posting id, title, Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id, Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item, Retrieve a list of ATS applications — 200 response body — data item candidate, Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage, Retrieve a list of ATS applications — 200 response body — data item stage history item
Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application form submission data with parsed answers |
answers | JSON | Required within parent | |
answers (anyOf 1) | array | Alternative | Array of parsed form submission answers |
answers (anyOf 1)[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item |
answers (anyOf 2) | null | Alternative | Array of parsed form submission answers |
answers (anyOf 2)[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Identifier of the application form submission Format: uuid |
id (anyOf 2) | null | Alternative | Identifier of the application form submission Format: uuid |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item
Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parsed form submission answer |
answer | Model | Required within parent | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value |
data_binding_id | string | Required within parent | Data binding identifier for the question Format: uuid |
question_text | string | Required within parent | Text of the question |
question_type | string | Required within parent | Type of the question (uppercase) Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, DOCUMENTUPLOAD, PRESETDROPDOWN, CUSTOMDROPDOWN, NUMBER, DATEPICKER, ADDRESS, PHONENUMBER, EMAIL |
Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | AI-generated job criteria matching result |
description | string | Required within parent | Job criteria matching description |
id | string | Required within parent | Job criteria matching unique identifier Format: uuid |
is_matched | string | Required within parent | Whether the criteria is matched Known values: MATCHED, NOT_MATCHED, UNDECIDED |
job_criteria_id | string | Required within parent | Job criteria unique identifier Format: uuid |
Retrieve a list of ATS applications — 200 response body — data item candidate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate information associated with the application |
candidate_tags | array | Required within parent | Tags associated with the candidate |
candidate_tags[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | Candidate city |
city (anyOf 2) | null | Alternative | Candidate city |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | Candidate country code (ISO 3166-1 alpha-2) |
country_code (anyOf 2) | null | Alternative | Candidate country code (ISO 3166-1 alpha-2) |
email | string | Required within parent | Candidate email address Format: email |
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 |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Candidate phone number (may be empty string or null) |
phone_number (anyOf 2) | null | Alternative | Candidate phone number (may be empty string or null) |
pic_url | JSON | Required within parent | |
pic_url (anyOf 1) | string | Alternative | Candidate profile picture URL |
pic_url (anyOf 2) | null | Alternative | Candidate profile picture URL |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item
Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate tag with label |
id | string | Required within parent | Candidate tag unique identifier Format: uuid |
tag | Model | Required within parent | Expand Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item tag |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item tag
Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item tag
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Tag unique identifier Format: uuid |
label | string | Required within parent | Tag label |
Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current interview plan stage information for the application |
application_id | string | Required within parent | Application unique identifier Format: uuid |
id | string | Required within parent | Application interview plan stage unique identifier Format: uuid |
interview_plan_stage | Model | Required within parent | Expand Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage interview plan stage |
interview_plan_stage_id | string | Required within parent | Interview plan stage unique identifier Format: uuid |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage interview plan stage
Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage interview plan stage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_type_slug | string | Required within parent | Interview plan stage category type |
default_type_slug | JSON | Required within parent | |
default_type_slug (anyOf 1) | string | Alternative | Interview plan stage default type slug |
default_type_slug (anyOf 2) | null | Alternative | Interview plan stage default type slug |
id | string | Required within parent | Interview plan stage unique identifier Format: uuid |
name | string | Required within parent | Interview plan stage name |
position_number | JSON | Required within parent | |
position_number (anyOf 1) | JSON | Alternative | |
position_number (anyOf 1) (anyOf 1) | integer | Alternative | Ordinal position of the stage in its job pipeline. Ranges are stable across organizations: below 2000 for lead stages, 2000 for application review, 2001-2998 for the customer-defined interview rounds, 2999 for offer, 3000 and above for hired and archived. |
position_number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
position_number (anyOf 2) | null | Alternative | Ordinal position of the stage in its job pipeline. Ranges are stable across organizations: below 2000 for lead stages, 2000 for application review, 2001-2998 for the customer-defined interview rounds, 2999 for offer, 3000 and above for hired and archived. |
Retrieve a list of ATS applications — 200 response body — data item job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job information for the application |
id | string | Required within parent | Job unique identifier Format: uuid |
title | string | Required within parent | Job title |
Retrieve a list of ATS applications — 200 response body — data item job employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type information for the job |
employment_type | Model | Required within parent | Expand Retrieve a list of ATS applications — 200 response body — data item job employment type employment type |
id | string | Required within parent | Job employment type unique identifier Format: uuid |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item job employment type employment type
Retrieve a list of ATS applications — 200 response body — data item job employment type employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Employment type unique identifier Format: uuid |
name | string | Required within parent | Employment type name |
Retrieve a list of ATS applications — 200 response body — data item job posting id, title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting information (if application came through a posting) |
id | string | Required within parent | Job posting unique identifier Format: uuid |
title | string | Required within parent | Job posting title |
Retrieve a list of ATS applications — 200 response body — data item stage history item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One visit of the application to an interview plan stage, in chronological order |
entered_at | string | Required within parent | Timestamp when the application entered this stage Format: date-time |
exited_at | JSON | Required within parent | |
exited_at (anyOf 1) | string | Alternative | Timestamp when the application left this stage; null while the application is still in it Format: date-time |
exited_at (anyOf 2) | null | Alternative | Timestamp when the application left this stage; null while the application is still in it Format: date-time |
id | string | Required within parent | Identifier of the stage history record Format: uuid |
interview_plan_stage | Model | Required within parent | Expand Retrieve a list of ATS applications — 200 response body — data item stage history item interview plan stage The interview plan stage this history record refers to |
is_current | boolean | Required within parent | Whether this is the stage the application is currently in |
moved_by_hris_organization_user_id | JSON | Required within parent | |
moved_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user who moved the application into this stage; null for automated moves Format: uuid |
moved_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user who moved the application into this stage; null for automated moves Format: uuid |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item stage history item interview plan stage
Retrieve a list of ATS applications — 200 response body — data item stage history item interview plan stage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The interview plan stage this history record refers to |
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 (e.g. new_lead, application_review, offer, hired, archived); null for custom stages |
default_type_slug (anyOf 2) | null | Alternative | System stage type (e.g. 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 a list of ATS applications — request body — query job criterias matchings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_matched | string | Required within parent | One of: MATCHED, NOT_MATCHED, UNDECIDED |
job_criteria_id | string | Required within parent | Format: uuid |