Deel: ATS schemas (part 1)
94 Deel schemas with complete fields and constraints.
← ATS operations · All schemas
Add content to the private note of a job — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add content to the private note of a job — 201 response body — data The job note after the write |
Referenced models: Add content to the private note of a job — 201 response body — data
Add content to the private note of a job — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The job note after the write |
created_at | string | Required within parent | The timestamp when the note was created Format: date-time |
created_by_hris_organization_user_id | JSON | Required within parent | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who created the note Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who created the note Format: uuid |
id | string | Required within parent | The unique identifier of the job note Format: uuid |
richtext_content | string | Required within parent | The content of the note in rich text HTML format |
updated_at | string | Required within parent | The timestamp when the note was last changed Format: date-time |
updated_by_hris_organization_user_id | JSON | Required within parent | |
updated_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who last changed the note Format: uuid |
updated_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who last changed the note Format: uuid |
Add content to the private note of a job — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_updated_at | string or null | Optional | Optional precondition: the note's updated_at as last read, or null when the job had no note. If the note changed since, nothing is written and a 409 precondition_failed is returned. Format: date-time |
richtext_content | string | Required within parent | Rich text HTML to add. It becomes the note when the job has none, otherwise it is appended after the existing content. Minimum length: 1 |
Add note to a candidate — ats add Note To Acandidate — 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 Maximum length: 10000 |
Add note to a candidate — ats add Note To Candidate — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add note to a candidate — ats add Note To Candidate — 201 response body — data The created candidate note |
Referenced models: Add note to a candidate — ats add Note To Candidate — 201 response body — data
Add note to a candidate — ats add Note To Candidate — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created candidate note |
created_at | string | Required within parent | The timestamp when the candidate note was created Format: date-time |
id | string | Required within parent | The unique identifier of the candidate note Format: uuid |
updated_at | string | Required within parent | The timestamp when the candidate note was last updated Format: date-time |
Add note to a candidate — ats add Note To Candidate — 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 Maximum length: 10000 |
Create a stage move for an application — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a stage move for an application — 201 response body — data The application's new current interview plan stage record |
Referenced models: Create a stage move for an application — 201 response body — data
Create a stage move for an application — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application's new current 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 ID of the application's new current interview plan stage record Format: uuid |
updated_at | string | Required within parent | The timestamp when the record was last updated Format: date-time |
Create a stage move for an application — 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 the application enters the 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 Create a stage move for an application — request body — body data applicable job activities item |
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 move the application to. Stages of the completed category are rejected. Format: uuid |
Referenced models: Create a stage move for an application — request body — body data applicable job activities item
Create a stage move for an application — 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 |
job_activity_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 a stage move for an application — request body — body data applicable job activities item participants item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
participant_hris_organization_user_id | string | Required within parent | The HRIS organization user ID of the participant Format: uuid |
role_slug | string | Required within parent | The role of the participant in the activity One of: REVIEWER, INTERVIEWER |
Create an email draft to a candidate — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create an email draft to a candidate — 201 response body — data The new draft, rendered as it would be sent |
Referenced models: Create an email draft to a candidate — 201 response body — data
Create an email draft to a candidate — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The new draft, rendered as it would be sent |
application_id | JSON | Required within parent | |
application_id (anyOf 1) | string | Alternative | The application the draft is about, or null for a draft about the candidate only Format: uuid |
application_id (anyOf 2) | null | Alternative | The application the draft is about, or null for a draft about the candidate only Format: uuid |
attachments | array | Required within parent | Files attached to the draft |
attachments[] | Model | Each item | Expand Create an email draft to a candidate — 201 response body — data attachments item |
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 with its placeholders filled in |
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 goes out as: the author's connected mailbox when they have one, otherwise the organization's sender |
id | string | Required within parent | The unique identifier of the email draft Format: uuid |
subject | string | Required within parent | The subject with its placeholders filled in |
to | array | Required within parent | Primary recipients, with dynamic recipients such as the candidate resolved to addresses |
to[] | string | Each item | Format: email |
unresolved_placeholders | array | Required within parent | Placeholders left unfilled in the subject or body. The draft cannot be sent while any remain. |
unresolved_placeholders[] | string | Each item | |
updated_at | string | Required within parent | The timestamp when the draft was last changed Format: date-time |
Referenced models: Create an email draft to a candidate — 201 response body — data attachments item
Create an email draft to a candidate — 201 response body — data attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_name | string | Required within parent | The name of the attached file |
id | string | Required within parent | The unique identifier of the attachment Format: uuid |
Create an email draft to a candidate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | string | Optional | The application of the candidate the draft is about. Required unless the caller is an ATS admin, since access to emails is granted per job. Format: uuid |
bcc | array | Optional | BCC recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS. |
bcc[] | string | Each item | |
body | string | Required within parent | The rich text HTML body. May contain placeholders, filled when the draft is rendered. |
cc | array | Optional | CC recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS. |
cc[] | string | Each item | |
subject | string | Required within parent | The subject. May contain placeholders such as ${{candidate.firstName}}, filled when the draft is rendered. Maximum length: 1000 |
to | array | Required within parent | Primary recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS. |
to[] | string | Each item |
Create an offer for an application in the offer stage — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create an offer for an application in the offer stage — 201 response body — data The created offer |
Referenced models: Create an offer for an application in the offer stage — 201 response body — data
Create an offer for an application in the offer stage — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created offer |
application_interview_plan_stage_id | string | Required within parent | ID of the application's offer stage record the offer belongs to Format: uuid |
approval_policy_id | JSON | Required within parent | |
approval_policy_id (anyOf 1) | string | Alternative | ID of the approval policy applied to the offer Format: uuid |
approval_policy_id (anyOf 2) | null | Alternative | ID of the approval policy applied to the offer Format: uuid |
approval_request_id | JSON | Required within parent | |
approval_request_id (anyOf 1) | string | Alternative | ID of the approval request opened for an approval rule Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | ID of the approval request opened for an approval rule Format: uuid |
approval_rule_id | JSON | Required within parent | |
approval_rule_id (anyOf 1) | string | Alternative | ID of the approval rule applied to the offer Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | ID of the approval rule applied to the offer Format: uuid |
created_at | string | Required within parent | Timestamp when the offer was created Format: date-time |
id | string | Required within parent | ID of the created offer Format: uuid |
offer_status | string | Required within parent | Status of the new offer: WAITING_FOR_APPROVAL when an approval applies, otherwise CREATED Known values: CREATED, WAITING_FOR_APPROVAL |
Create an offer for an application in the offer stage — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | string or null | Optional | Additional details shown with the offer |
approval_policy_id | string or null | Optional | ID of the approval policy the offer goes through, for organizations that use approval policies Format: uuid |
approval_rule_id | string or null | Optional | ID of the approval rule the offer goes through, for organizations that use approval rules Format: uuid |
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 |
expires_at | string or null | Optional | Date the offer expires once sent if the candidate has not answered Format: date |
job_title | string | Required within parent | Job title offered to the candidate |
offer_letter_template_id | string or null | Optional | ID of the offer letter template to attach. Archived templates are rejected. Format: uuid |
opening_id | string or null | Optional | ID of the job opening the offer fills Format: uuid |
start_date | string | Required within parent | Proposed start date of the candidate Format: date-time |
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 |
Generate a preview of an ATS email template — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Generate a preview of an ATS email template — 200 response body — data |
Referenced models: Generate a preview of an ATS email template — 200 response body — data
Generate a preview of an ATS email template — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
body | string | Required within parent | Rendered body as sanitized HTML. Unresolved placeholders are left in place. |
subject | string | Required within parent | Rendered subject as plain text. Unresolved placeholders are left in place. |
unresolved_placeholders | array | Required within parent | Distinct placeholders that could not be filled, as they appear in the text. interview.*, questionnaire.link, document.*, application_form.link and referrer.fullName are only supplied when the email is sent, so they are always listed. |
unresolved_placeholders[] | string | Each item |
Get an interview transcript — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of transcript segments, ordered by the time they were spoken. |
data[] | Model | Each item | Expand Get an interview transcript — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 transcript segments for this interview. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get an interview transcript — 200 response body — data item
Get an interview transcript — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the transcript segment. Format: uuid |
is_meeting_host | boolean | Required within parent | Whether the speaker was the meeting host. |
offset_seconds | JSON | Required within parent | |
offset_seconds (anyOf 1) | integer | Alternative | Seconds elapsed since the start of the interview when the segment was spoken. |
offset_seconds (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
speaker_name | string | Required within parent | Name of the meeting participant who spoke this segment, as captured by the transcription bot. |
spoken_at | string | Required within parent | ISO 8601 datetime when the segment was spoken. Format: date-time |
text | string | Required within parent | Verbatim text of the spoken segment. May contain special-category data the candidate volunteered. |
Get interview notes — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of interview notes, oldest first. |
data[] | Model | Each item | Expand Get interview notes — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 notes for this interview, across all pages. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get interview notes — 200 response body — data item
Get interview notes — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_text | string | Required within parent | AI-generated note text summarising part of the interview. Condenses what the candidate said and may contain personal data they volunteered. |
created_at | string | Required within parent | ISO 8601 datetime when the note was generated. Format: date-time |
id | string | Required within parent | Unique identifier of the interview note. Format: uuid |
title | string | Required within parent | Short AI-generated title of the note. Derived from the interview conversation. |
transcription_content_id | JSON | Required within parent | |
transcription_content_id (anyOf 1) | string | Alternative | Identifier of the transcript segment the note was generated from, matching a segment id of the interview transcript; null when the note is not linked to a single segment. Format: uuid |
transcription_content_id (anyOf 2) | null | Alternative | Identifier of the transcript segment the note was generated from, matching a segment id of the interview transcript; null when the note is not linked to a single segment. Format: uuid |
type_slug | string | Required within parent | Kind of note: SUMMARY (overall summary), KEY_POINT (a highlight) or OUTLINE (an agenda item of the conversation). Known values: SUMMARY, KEY_POINT, OUTLINE |
List available slots for an interview — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Available slots in the window, earliest first |
data[] | Model | Each item | Expand List available slots for an interview — 200 response body — data item |
has_more | boolean | Required within parent | Always false: every slot in the window is returned at once. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: every slot in the window is returned at once. |
next_cursor (anyOf 2) | null | Alternative | Always null: every slot in the window is returned at once. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of available slots in the window. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List available slots for an interview — 200 response body — data item
List available slots for an interview — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_time | string | Required within parent | End of the available slot Format: date-time |
start_time | string | Required within parent | Start of the available slot Format: date-time |
List email drafts to a candidate as they would be sent — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The caller's own drafts to the candidate, most recently changed first, rendered as they would be sent |
data[] | Model | Each item | Expand List email drafts to a candidate as they would be sent — 200 response body — data item |
has_more | boolean | Required within parent | Whether the caller has more drafts to the candidate than the page holds |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: the most recently changed drafts are returned in a single page. |
next_cursor (anyOf 2) | null | Alternative | Always null: the most recently changed drafts are returned in a single page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of the caller's drafts to the candidate |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List email drafts to a candidate as they would be sent — 200 response body — data item
List email drafts to a candidate as they would be sent — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | JSON | Required within parent | |
application_id (anyOf 1) | string | Alternative | The application the draft is about, or null for a draft about the candidate only Format: uuid |
application_id (anyOf 2) | null | Alternative | The application the draft is about, or null for a draft about the candidate only Format: uuid |
attachments | array | Required within parent | Files attached to the draft |
attachments[] | Model | Each item | Expand Create an email draft to a candidate — 201 response body — data attachments item |
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 with its placeholders filled in |
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 goes out as: the author's connected mailbox when they have one, otherwise the organization's sender |
id | string | Required within parent | The unique identifier of the email draft Format: uuid |
subject | string | Required within parent | The subject with its placeholders filled in |
to | array | Required within parent | Primary recipients, with dynamic recipients such as the candidate resolved to addresses |
to[] | string | Each item | Format: email |
unresolved_placeholders | array | Required within parent | Placeholders left unfilled in the subject or body. The draft cannot be sent while any remain. |
unresolved_placeholders[] | string | Each item | |
updated_at | string | Required within parent | The timestamp when the draft was last changed Format: date-time |
Referenced models: Create an email draft to a candidate — 201 response body — data attachments item
List feedbacks for an application — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of application feedbacks. |
data[] | Model | Each item | Expand List feedbacks for an application — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 feedbacks for this application. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List feedbacks for an application — 200 response body — data item
List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country code. |
country (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code. |
first_name | string | Optional | First name. |
full_name | string | Optional | Full name. |
hris_organization_user_id | string | Optional | HRIS organization user ID. Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title. |
job_title (anyOf 2) | null | Alternative | Job title. |
last_name | string | Optional | Last name. |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | Profile picture URL. |
pic_url (anyOf 2) | null | Alternative | Profile picture URL. |
type | string | Optional | Participant type within the organization. Known values: CLIENT, WORKER |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email. Format: email |
work_email (anyOf 2) | null | Alternative | Work email. Format: email |
List feedbacks for an application — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
activity_type | JSON | Optional | |
activity_type (anyOf 1) | string | Alternative | Type slug of the interview activity. |
activity_type (anyOf 2) | null | Alternative | Type slug of the interview activity. |
application_activity_id | string | Required within parent | Activity the feedback belongs to. Format: uuid |
created_at | string | Required within parent | ISO 8601 datetime when the feedback record was created. Format: date-time |
dismissal_reason | JSON | Optional | Reason the reviewer selected when dismissing the feedback request. Null when the request was dismissed from the reviewer's Deel Tasks list, which records no reason. |
dismissal_reason (anyOf 1) | Model | Alternative | Expand List feedbacks for an application — 200 response body — data item dismissal reason id, label |
dismissal_reason (anyOf 2) | null | Alternative | |
dismissed_at | JSON | Optional | |
dismissed_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the reviewer dismissed the feedback request. Format: date-time |
dismissed_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the reviewer dismissed the feedback request. Format: date-time |
feedback_form | Model | Required within parent | Expand List feedbacks for an application — 200 response body — data item feedback form Feedback form template used for this feedback. |
form_responses | JSON | Optional | |
form_responses (anyOf 1) | array | Alternative | Submitted form question/answer pairs from FormBuilder. |
form_responses (anyOf 1)[] | Model | Each item | Expand List feedbacks for an application — 200 response body — data item form responses null item |
form_responses (anyOf 2) | null | Alternative | Submitted form question/answer pairs from FormBuilder. |
form_responses (anyOf 2)[] | Model | Each item | Expand List feedbacks for an application — 200 response body — data item form responses null item |
id | string | Required within parent | Unique identifier of the feedback record. Format: uuid |
overall_recommendation | JSON | Optional | Overall recommendation selected by the reviewer. |
overall_recommendation (anyOf 1) | Model | Alternative | Expand List feedbacks for an application — 200 response body — data item overall recommendation Overall recommendation selected by the reviewer |
overall_recommendation (anyOf 2) | null | Alternative | |
reviewer | Model | Required within parent | Expand List feedbacks for an application — 200 response body — data item reviewer Reviewer who provided the feedback. |
revocation_reason_enum | JSON | Optional | Why the system revoked the feedback request. |
revocation_reason_enum (anyOf 1) | string | Alternative | Why the system revoked the feedback request. Known values: JOB_CLOSED, APPLICATION_COMPLETED |
revocation_reason_enum (anyOf 2) | null | Alternative | |
revoked_at | JSON | Optional | |
revoked_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the system revoked the feedback request. Format: date-time |
revoked_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the system revoked the feedback request. Format: date-time |
scheduled_interview_id | JSON | Required within parent | |
scheduled_interview_id (anyOf 1) | string | Alternative | Scheduled interview the feedback was collected for (see GET /rest/ats/interviews); null for non-interview activities. Format: uuid |
scheduled_interview_id (anyOf 2) | null | Alternative | Scheduled interview the feedback was collected for (see GET /rest/ats/interviews); null for non-interview activities. Format: uuid |
stage_name | JSON | Optional | |
stage_name (anyOf 1) | string | Alternative | Name of the interview plan stage. |
stage_name (anyOf 2) | null | Alternative | Name of the interview plan stage. |
status | string | Required within parent | Submission status of the feedback. DISMISSED means the reviewer dismissed the request with a reason. REVOKED means the system withdrew it because the job closed or the application reached a terminal stage. Known values: SUBMITTED, NOT_SUBMITTED, DISMISSED, REVOKED |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the feedback was submitted. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the feedback was submitted. Format: date-time |
Referenced models: List feedbacks for an application — 200 response body — data item dismissal reason id, label, List feedbacks for an application — 200 response body — data item feedback form, List feedbacks for an application — 200 response body — data item form responses null item, List feedbacks for an application — 200 response body — data item overall recommendation Overall recommendation selected by the reviewer, List feedbacks for an application — 200 response body — data item reviewer
List feedbacks for an application — 200 response body — data item dismissal reason id, label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reason the reviewer selected when dismissing the feedback request. Null when the request was dismissed from the reviewer's Deel Tasks list, which records no reason. |
id | string | Optional | Unique identifier of the reason. Format: uuid |
label | string | Optional | Label of the reason. |
List feedbacks for an application — 200 response body — data item feedback form
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Feedback form template used for this feedback. |
id | string | Required within parent | Unique identifier of the feedback form. Format: uuid |
title | string | Required within parent | Title of the feedback form. |
List feedbacks for an application — 200 response body — data item form responses null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | Model | Required within parent | Expand List feedbacks for an application — 200 response body — data item form responses null item answer Answer value; shape varies by question type (string, number, array, or object). |
question_text | string | Required within parent | Text of the feedback form question. |
question_type | string | Required within parent | Type of the question field. |
Referenced models: List feedbacks for an application — 200 response body — data item form responses null item answer
List feedbacks for an application — 200 response body — data item form responses null item answer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Answer value; shape varies by question type (string, number, array, or object). |
$ (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]+)?$ |
$ (anyOf 3) | boolean | Alternative | |
$ (anyOf 4) | array | Alternative | |
$ (anyOf 4)[] | JSON | Each item | Any type |
$ (anyOf 5) | object | Alternative | Additional keys: see wildcard field |
$ (anyOf 5).* | JSON | Additional keys | Any type |
List feedbacks for an application — 200 response body — data item overall recommendation Overall recommendation selected by the reviewer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Overall recommendation selected by the reviewer. |
scale_item_id | string | Optional | Unique identifier of the selected feedback scale item. Format: uuid |
scale_item_label | string | Optional | Display label of the selected scale item. |
scale_title | JSON | Optional | |
scale_title (anyOf 1) | string | Alternative | Title of the feedback scale. |
scale_title (anyOf 2) | null | Alternative | Title of the feedback scale. |
List feedbacks for an application — 200 response body — data item reviewer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer who provided the feedback. |
participant_hris_organization_user_id | string | Required within parent | HRIS organization user ID of the reviewer. Format: uuid |
reviewer_profile | JSON | Optional | |
reviewer_profile (anyOf 1) | Model | Alternative | Expand List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER |
reviewer_profile (anyOf 2) | null | Alternative |
Referenced models: List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER
List interview and evaluation feedback across the organization — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of feedback records. |
data[] | Model | Each item | Expand List interview and evaluation feedback across the organization — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 feedback records matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List interview and evaluation feedback across the organization — 200 response body — data item
List interview and evaluation feedback across the organization — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
activity_type | JSON | Required within parent | Kind of activity the feedback belongs to. |
activity_type (anyOf 1) | string | Alternative | Kind of activity the feedback belongs to. Known values: INTERVIEW_SCHEDULING, APPLICATION_EVALUATION, EXERCISE, QUESTIONNAIRE, EMAIL_SENDING |
activity_type (anyOf 2) | null | Alternative | |
application | Model | Required within parent | Expand List interview and evaluation feedback across the organization — 200 response body — data item application Application the feedback is about. |
application_activity_id | string | Required within parent | Activity the feedback belongs to. Format: uuid |
application_interview_plan_stage_id | JSON | Required within parent | |
application_interview_plan_stage_id (anyOf 1) | string | Alternative | Application stage record the activity belongs to. Format: uuid |
application_interview_plan_stage_id (anyOf 2) | null | Alternative | Application stage record the activity belongs to. Format: uuid |
created_at | string | Required within parent | When the feedback request was created. Format: date-time |
feedback_form | Model | Required within parent | Expand List interview and evaluation feedback across the organization — 200 response body — data item feedback form Scorecard template used. |
form_responses | JSON | Optional | |
form_responses (anyOf 1) | array | Alternative | Submitted scorecard answers. Present only when include=FORM_RESPONSES is requested; null when nothing was submitted. |
form_responses (anyOf 1)[] | Model | Each item | Expand List interview and evaluation feedback across the organization — 200 response body — data item form responses null item |
form_responses (anyOf 2) | null | Alternative | Submitted scorecard answers. Present only when include=FORM_RESPONSES is requested; null when nothing was submitted. |
form_responses (anyOf 2)[] | Model | Each item | Expand List interview and evaluation feedback across the organization — 200 response body — data item form responses null item |
id | string | Required within parent | Unique identifier of the feedback record. Format: uuid |
interview_plan_stage | JSON | Required within parent | Interview plan stage the activity belongs to. |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand List interview and evaluation feedback across the organization — 200 response body — data item interview plan stage Interview plan stage the activity belongs to |
interview_plan_stage (anyOf 2) | null | Alternative | |
overall_recommendation | JSON | Required within parent | The recommendation the reviewer selected; null while pending. |
overall_recommendation (anyOf 1) | Model | Alternative | Expand List interview and evaluation feedback across the organization — 200 response body — data item overall recommendation scale id, scale item id, scale item label, scale item position, scale items count, scale title |
overall_recommendation (anyOf 2) | null | Alternative | |
reviewer | Model | Required within parent | Expand List interview and evaluation feedback across the organization — 200 response body — data item reviewer Reviewer who owes or provided the feedback. |
scheduled_interview | JSON | Required within parent | The interview the feedback was collected for; null for non-interview activities. |
scheduled_interview (anyOf 1) | Model | Alternative | Expand List interview and evaluation feedback across the organization — 200 response body — data item scheduled interview ends at, has happened, id, starts at, status enum |
scheduled_interview (anyOf 2) | null | Alternative | |
status | string | Required within parent | Submission status. Known values: SUBMITTED, NOT_SUBMITTED |
submitted_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | When the feedback was submitted; null while still owed. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | When the feedback was submitted; null while still owed. Format: date-time |
updated_at | string | Required within parent | When the feedback was last updated. Format: date-time |
Referenced models: List interview and evaluation feedback across the organization — 200 response body — data item feedback form, List interview and evaluation feedback across the organization — 200 response body — data item interview plan stage Interview plan stage the activity belongs to, List interview and evaluation feedback across the organization — 200 response body — data item application, List interview and evaluation feedback across the organization — 200 response body — data item form responses null item, List interview and evaluation feedback across the organization — 200 response body — data item overall recommendation scale id, scale item id, scale item label, scale item position, scale items count, scale title, List interview and evaluation feedback across the organization — 200 response body — data item reviewer, List interview and evaluation feedback across the organization — 200 response body — data item scheduled interview ends at, has happened, id, starts at, status enum
List interview and evaluation feedback across the organization — 200 response body — data item application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application the feedback is about. |
candidate | Model | Required within parent | Expand List interview and evaluation feedback across the organization — 200 response body — data item application candidate Candidate on the application. |
current_application_interview_plan_stage | JSON | Required within parent | Where the candidate is now. |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand List interview and evaluation feedback across the organization — 200 response body — data item application current application interview plan stage Where the candidate is now |
current_application_interview_plan_stage (anyOf 2) | null | Alternative | |
id | string | Required within parent | Application identifier. Format: uuid |
job | Model | Required within parent | Expand List interview and evaluation feedback across the organization — 200 response body — data item application job Job of the application. |
Referenced models: List interview and evaluation feedback across the organization — 200 response body — data item application candidate, List interview and evaluation feedback across the organization — 200 response body — data item application job, List interview and evaluation feedback across the organization — 200 response body — data item application current application interview plan stage Where the candidate is now
List interview and evaluation feedback across the organization — 200 response body — data item application candidate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate on the application. |
email | string | Required within parent | Candidate email. Format: email |
first_name | string | Required within parent | Candidate first name. |
id | string | Required within parent | Candidate identifier. Format: uuid |
last_name | string | Required within parent | Candidate last name. |
List interview and evaluation feedback across the organization — 200 response body — data item application current application interview plan stage Where the candidate is now
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where the candidate 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 List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage |
interview_plan_stage (anyOf 2) | null | Alternative |
List interview and evaluation feedback across the organization — 200 response body — data item application job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job of the application. |
id | string | Required within parent | Job identifier. Format: uuid |
title | string | Required within parent | Job title. |
List interview and evaluation feedback across the organization — 200 response body — data item feedback form
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Scorecard template used. |
id | string | Required within parent | Feedback form identifier. Format: uuid |
title | string | Required within parent | Feedback form title. |
List interview and evaluation feedback across the organization — 200 response body — data item form responses null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | Model | Required within parent | Expand List feedbacks for an application — 200 response body — data item form responses null item answer Answer value; shape varies by question type (string, number, array, or object). |
question_text | string | Required within parent | Text of the scorecard question. |
question_type | string | Required within parent | Type of the question field. |
Referenced models: List feedbacks for an application — 200 response body — data item form responses null item answer
List interview and evaluation feedback across the organization — 200 response body — data item interview plan stage Interview plan stage the activity belongs to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Interview plan stage the activity belongs to. |
category_type_slug | string | Required within parent | Stage category: lead, active or completed. |
id | string | Required within parent | Interview plan stage identifier. Format: uuid |
name | string | Required within parent | Customer-defined stage name. |
List interview and evaluation feedback across the organization — 200 response body — data item overall recommendation scale id, scale item id, scale item label, scale item position, scale items count, scale title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The recommendation the reviewer selected; null while pending. |
scale_id | string | Required within parent | Feedback scale identifier. Format: uuid |
scale_item_id | string | Required within parent | Selected scale item. Format: uuid |
scale_item_label | string | Required within parent | Label of the selected scale item. |
scale_item_position | JSON | Required within parent | |
scale_item_position (anyOf 1) | integer | Alternative | Zero-based position of the selected item within its scale, lowest first — comparable across labels. |
scale_item_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scale_items_count | JSON | Required within parent | |
scale_items_count (anyOf 1) | integer | Alternative | Number of items in the scale. |
scale_items_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scale_title | JSON | Required within parent | |
scale_title (anyOf 1) | string | Alternative | Feedback scale title. |
scale_title (anyOf 2) | null | Alternative | Feedback scale title. |
List interview and evaluation feedback across the organization — 200 response body — data item reviewer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer who owes or provided the feedback. |
participant_hris_organization_user_id | string | Required within parent | HRIS organization user ID of the reviewer. Format: uuid |
reviewer_profile | JSON | Optional | |
reviewer_profile (anyOf 1) | Model | Alternative | Expand List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER |
reviewer_profile (anyOf 2) | null | Alternative |
Referenced models: List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER
List interview and evaluation feedback across the organization — 200 response body — data item scheduled interview ends at, has happened, id, starts at, status enum
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The interview the feedback was collected for; null for non-interview activities. |
ends_at | JSON | Required within parent | |
ends_at (anyOf 1) | string | Alternative | Interview end. Format: date-time |
ends_at (anyOf 2) | null | Alternative | Interview end. Format: date-time |
has_happened | boolean | Required within parent | True when the interview took place; combine with status NOT_SUBMITTED to find overdue scorecards. |
id | string | Required within parent | Scheduled interview identifier. Format: uuid |
starts_at | JSON | Required within parent | |
starts_at (anyOf 1) | string | Alternative | Interview start. Format: date-time |
starts_at (anyOf 2) | null | Alternative | Interview start. Format: date-time |
status_enum | string | Required within parent | Interview status. |
List interview plan stages of a job with pipeline counts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Stages of the job's interview plan, in pipeline order. |
data[] | Model | Each item | Expand List interview plan stages of a job with pipeline counts — 200 response body — data item |
has_more | boolean | Required within parent | Always false; the list is not paginated. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null; the list is not paginated. |
next_cursor (anyOf 2) | null | Alternative | Always null; the list is not paginated. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of stages. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item
List interview plan stages of a job with pipeline counts — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An interview plan stage of the job with pipeline counts. |
category_type_slug | string | Required within parent | Stage category. Known values: LEAD, ACTIVE, COMPLETED |
current_applications | array | Optional | Most recently moved applications currently in the stage. Present only when include=CURRENT_APPLICATIONS is requested. |
current_applications[] | Model | Each item | Expand List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item |
current_applications_count | JSON | Required within parent | |
current_applications_count (anyOf 1) | JSON | Alternative | |
current_applications_count (anyOf 1) (anyOf 1) | integer | Alternative | Applications currently in this stage; null when the caller may not see the job's applications. |
current_applications_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
current_applications_count (anyOf 2) | null | Alternative | Applications currently in this stage; null when the caller may not see the job's applications. |
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 |
interview_plan_id | string | Required within parent | Interview plan the stage belongs to. Format: uuid |
job_id | string | Required within parent | Job the interview plan is attached to. 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; lower comes first. |
position_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reached_applications_count | JSON | Required within parent | |
reached_applications_count (anyOf 1) | JSON | Alternative | |
reached_applications_count (anyOf 1) (anyOf 1) | integer | Alternative | Applications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications. |
reached_applications_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reached_applications_count (anyOf 2) | null | Alternative | Applications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications. |
Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item
List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An application currently in the stage. |
candidate | Model | Required within parent | Expand List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate The candidate on the application. |
created_at | string | Required within parent | When the application was created. Format: date-time |
id | string | Required within parent | Application identifier. Format: uuid |
moved_to_current_stage_at | string | Required within parent | When the application entered this 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]+)?$ |
Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate
List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The candidate on the application. |
email | string | Required within parent | Candidate email. Format: email |
first_name | string | Required within parent | Candidate first name. |
id | string | Required within parent | Candidate identifier. Format: uuid |
last_name | string | Required within parent | Candidate last name. |
List interviews across applications — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of interviews. |
data[] | Model | Each item | Expand List interviews across applications — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 interviews matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List interviews across applications — 200 response body — data item
List interviews across applications — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application Application linked to this interview. |
application_activity | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application activity Interview activity details including configuration and participants. |
application_activity_id | string | Required within parent | ID of the application activity linked to this interview. Format: uuid |
application_interview_plan_stage_id | JSON | Optional | |
application_interview_plan_stage_id (anyOf 1) | string | Alternative | ID of the application stage record the interview belongs to. Format: uuid |
application_interview_plan_stage_id (anyOf 2) | null | Alternative | ID of the application stage record the interview belongs to. Format: uuid |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | string | Alternative | Free-text cancellation reason; null unless cancelled. |
cancellation_reason (anyOf 2) | null | Alternative | Free-text cancellation reason; null unless cancelled. |
cancellation_reason_id | JSON | Optional | |
cancellation_reason_id (anyOf 1) | string | Alternative | Cancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled. Format: uuid |
cancellation_reason_id (anyOf 2) | null | Alternative | Cancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled. Format: uuid |
cancelled_at | JSON | Optional | |
cancelled_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the interview was cancelled; null unless cancelled. Format: date-time |
cancelled_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the interview was cancelled; null unless cancelled. Format: date-time |
created_at | string | Required within parent | ISO 8601 datetime when the interview record was created. 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 created the interview. Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user who created the interview. Format: uuid |
ends_at | JSON | Optional | |
ends_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the interview ends. Format: date-time |
ends_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the interview ends. Format: date-time |
has_happened | boolean | Optional | True when the interview took place: status SCHEDULED or COMPLETED and the meeting end (or start, when no end is recorded) is in the past. False for cancelled interviews and interviews not yet held. |
id | string | Required within parent | Unique identifier of the interview. Format: uuid |
interview_plan_stage | JSON | Optional | The interview plan stage the interview belongs to, independent of the candidate's current stage. |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number |
interview_plan_stage (anyOf 2) | null | Alternative | |
meeting_url | JSON | Optional | |
meeting_url (anyOf 1) | string | Alternative | Video conferencing URL for the interview. |
meeting_url (anyOf 2) | null | Alternative | Video conferencing URL for the interview. |
starts_at | JSON | Optional | |
starts_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the interview starts. Format: date-time |
starts_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the interview starts. Format: date-time |
status_enum | string | Required within parent | Current status of the interview. Known values: SCHEDULE_NEEDED, LINK_SENT, SLOT_REQUEST_SENT, SLOTS_SUBMITTED, SCHEDULED, RESCHEDULE_REQUESTED, CANCELLED, COMPLETED |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | IANA timezone of the interview. |
timezone (anyOf 2) | null | Alternative | IANA timezone of the interview. |
updated_at | string | Required within parent | ISO 8601 datetime when the interview record was last updated. Format: date-time |
Referenced models: List interviews across applications — 200 response body — data item application, List interviews across applications — 200 response body — data item application activity, List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number
List interviews across applications — 200 response body — data item application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application linked to this interview. |
candidate | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application candidate Candidate being interviewed. |
current_application_interview_plan_stage | JSON | Optional | The stage the candidate is in now, which may differ from the stage the interview belongs to. |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage |
current_application_interview_plan_stage (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the application. Format: uuid |
job | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application job Job linked to the application. |
Referenced models: List interviews across applications — 200 response body — data item application job, List interviews across applications — 200 response body — data item application candidate, List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage
List interviews across applications — 200 response body — data item application activity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Interview activity details including configuration and participants. |
application_activity_participations | array | Optional | List of interviewers participating in this interview. |
application_activity_participations[] | Model | Each item | Expand List interviews across applications — 200 response body — data item application activity application activity participations item |
interview_title | JSON | Optional | |
interview_title (anyOf 1) | string | Alternative | Title of the interview stage. |
interview_title (anyOf 2) | null | Alternative | Title of the interview stage. |
length_in_minutes | JSON | Optional | |
length_in_minutes (anyOf 1) | JSON | Alternative | |
length_in_minutes (anyOf 1) (anyOf 1) | integer | Alternative | Planned interview duration in minutes. |
length_in_minutes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
length_in_minutes (anyOf 2) | null | Alternative | Planned interview duration in minutes. |
Referenced models: List interviews across applications — 200 response body — data item application activity application activity participations item
List interviews across applications — 200 response body — data item application activity application activity participations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_activity_feedbacks | array | Optional | Feedback entries submitted by this participant for the interview. |
application_activity_feedbacks[] | Model | Each item | Expand List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item |
id | string | Required within parent | Unique identifier of the participation record. Format: uuid |
participant_hris_organization_user_id | string | Required within parent | HRIS organization user ID of the interviewer. Format: uuid |
participant_hris_organization_user_profile | JSON | Optional | |
participant_hris_organization_user_profile (anyOf 1) | Model | Alternative | Expand List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER |
participant_hris_organization_user_profile (anyOf 2) | null | Alternative |
Referenced models: List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER, List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item
List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the feedback record. Format: uuid |
overall_recommendation | JSON | Optional | The recommendation the interviewer selected (e.g. "Strong Yes"); null while pending or when the caller may only see their own recommendations. |
overall_recommendation (anyOf 1) | Model | Alternative | Expand List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item overall recommendation scale item id, scale item label |
overall_recommendation (anyOf 2) | null | Alternative | |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the feedback was submitted; null while it is still pending. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the feedback was submitted; null while it is still pending. Format: date-time |
List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item overall recommendation scale item id, scale item label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The recommendation the interviewer selected (e.g. "Strong Yes"); null while pending or when the caller may only see their own recommendations. |
scale_item_id | string | Required within parent | Feedback scale item identifier. Format: uuid |
scale_item_label | string | Required within parent | Feedback scale item label. |
List interviews across applications — 200 response body — data item application candidate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate being interviewed. |
email | string | Required within parent | Email address of the candidate. Format: email |
first_name | string | Required within parent | First name of the candidate. |
id | string | Required within parent | Unique identifier of the candidate. Format: uuid |
last_name | string | Required within parent | Last name of the candidate. |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | Profile picture URL of the candidate. |
pic_url (anyOf 2) | null | Alternative | Profile picture URL of the candidate. |
List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The stage the candidate is in now, which may differ from the stage the interview belongs to. |
id | string | Required within parent | Identifier of the 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 List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage |
interview_plan_stage (anyOf 2) | null | Alternative |
List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current interview plan stage. |
id | string | Required within parent | Interview plan stage identifier. Format: uuid |
name | string | Required within parent | Customer-defined stage name. |
List interviews across applications — 200 response body — data item application job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job linked to the application. |
id | string | Required within parent | Unique identifier of the job. Format: uuid |
title | string | Required within parent | Title of the job position. |
List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The interview plan stage the interview belongs to, independent of the candidate's current 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 (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]+)?$ |
List job openings — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of openings. |
data[] | Model | Each item | Expand List job openings — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 openings matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List job openings — 200 response body — data item
List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The accepted offer that filled this opening (latest ACCEPTED offer by update time). Null unless the opening is filled with an accepted offer. Contains no compensation data. |
offer_status_enum | string | Optional | Status of the filling offer. This object is only present for the accepted offer that filled the opening, so the value is always ACCEPTED. Known values: ACCEPTED |
start_date | string | Optional | Start date from the accepted offer (ISO 8601). Format: date-time |
List job openings — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compensation_currency_iso_code | JSON | Optional | |
compensation_currency_iso_code (anyOf 1) | string | Alternative | ISO 4217 currency code for compensation. |
compensation_currency_iso_code (anyOf 2) | null | Alternative | ISO 4217 currency code for compensation. |
compensation_period | JSON | Optional | |
compensation_period (anyOf 1) | string | Alternative | Compensation period (e.g. yearly, monthly). |
compensation_period (anyOf 2) | null | Alternative | Compensation period (e.g. yearly, monthly). |
created_at | string | Required within parent | ISO 8601 datetime when the opening was created. Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who created this opening. Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who created this opening. Format: uuid |
employment_type | JSON | Optional | Employment type details. |
employment_type (anyOf 1) | Model | Alternative | Expand List job openings — 200 response body — data item employment type Employment type details |
employment_type (anyOf 2) | null | Alternative | |
employment_type_id | JSON | Optional | |
employment_type_id (anyOf 1) | string | Alternative | ID of the employment type associated with the opening. Format: uuid |
employment_type_id (anyOf 2) | null | Alternative | ID of the employment type associated with the opening. Format: uuid |
filled_at | JSON | Optional | |
filled_at (anyOf 1) | string | Alternative | When the opening was filled. Null while it is unfilled. Format: date-time |
filled_at (anyOf 2) | null | Alternative | When the opening was filled. Null while it is unfilled. Format: date-time |
filled_by_application | JSON | Optional | The application that filled this opening, including the hired candidate name. Null unless the opening is filled. |
filled_by_application (anyOf 1) | Model | Alternative | Expand List job openings — 200 response body — data item filled by application candidate, id |
filled_by_application (anyOf 2) | null | Alternative | |
filled_by_application_id | JSON | Optional | |
filled_by_application_id (anyOf 1) | string | Alternative | ID of the application that filled this opening, if any. Format: uuid |
filled_by_application_id (anyOf 2) | null | Alternative | ID of the application that filled this opening, if any. Format: uuid |
filled_by_offer | JSON | Optional | The accepted offer that filled this opening (latest ACCEPTED offer by update time). Null unless the opening is filled with an accepted offer. Contains no compensation data. |
filled_by_offer (anyOf 1) | Model | Alternative | Expand List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED |
filled_by_offer (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the opening. Format: uuid |
is_confidential | boolean | Optional | Whether this opening is marked confidential. |
job_ids | array | Optional | IDs of jobs linked to this opening. |
job_ids[] | string | Each item | Format: uuid |
location | JSON | Optional | Location details. |
location (anyOf 1) | Model | Alternative | Expand List job openings — 200 response body — data item location Location details |
location (anyOf 2) | null | Alternative | |
location_id | JSON | Optional | |
location_id (anyOf 1) | string | Alternative | ID of the location associated with the opening. Format: uuid |
location_id (anyOf 2) | null | Alternative | ID of the location associated with the opening. Format: uuid |
max_compensation_amount | JSON | Optional | |
max_compensation_amount (anyOf 1) | string | Alternative | Maximum compensation amount as a decimal string. |
max_compensation_amount (anyOf 2) | null | Alternative | Maximum compensation amount as a decimal string. |
min_compensation_amount | JSON | Optional | |
min_compensation_amount (anyOf 1) | string | Alternative | Minimum compensation amount as a decimal string. |
min_compensation_amount (anyOf 2) | null | Alternative | Minimum compensation amount as a decimal string. |
opened_at | JSON | Optional | |
opened_at (anyOf 1) | string | Alternative | When the opening was last opened. Reset when the opening is reopened. Null when it was never opened. Format: date-time |
opened_at (anyOf 2) | null | Alternative | When the opening was last opened. Reset when the opening is reopened. Null when it was never opened. Format: date-time |
opening_numeric_id | JSON | Required within parent | |
opening_numeric_id (anyOf 1) | integer | Alternative | Numeric part of the opening identifier (e.g. 42 in ENG-42). |
opening_numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
opening_prefix | string | Required within parent | Prefix of the opening identifier (e.g. ENG in ENG-42). |
opening_type_slug | string | Required within parent | Whether this opening is for a new hire or a backfill. Known values: NEW_HIRE, BACKFILL |
recruiter_hris_organization_user_id | JSON | Optional | |
recruiter_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the recruiter responsible for the opening. Null when none is assigned. Format: uuid |
recruiter_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the recruiter responsible for the opening. Null when none is assigned. Format: uuid |
status | string | Required within parent | Current lifecycle status of the opening. Known values: DRAFT, OPEN, FILLED, CLOSED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED |
target_hire_date | JSON | Optional | |
target_hire_date (anyOf 1) | string | Alternative | Target date by which the opening should be filled (ISO 8601). Format: date-time |
target_hire_date (anyOf 2) | null | Alternative | Target date by which the opening should be filled (ISO 8601). Format: date-time |
target_start_date | JSON | Optional | |
target_start_date (anyOf 1) | string | Alternative | Target start date for the new hire (ISO 8601). Format: date-time |
target_start_date (anyOf 2) | null | Alternative | Target start date for the new hire (ISO 8601). Format: date-time |
team | JSON | Optional | Team details. |
team (anyOf 1) | Model | Alternative | Expand List job openings — 200 response body — data item team Team details |
team (anyOf 2) | null | Alternative | |
team_id | JSON | Optional | |
team_id (anyOf 1) | string | Alternative | ID of the team this opening belongs to. Format: uuid |
team_id (anyOf 2) | null | Alternative | ID of the team this opening belongs to. Format: uuid |
title | string | Required within parent | Title of the job opening. |
updated_at | string | Required within parent | ISO 8601 datetime when the opening was last updated. Format: date-time |
updated_by_hris_organization_user_id | JSON | Optional | |
updated_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who last updated this opening. Format: uuid |
updated_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who last updated this opening. Format: uuid |
Referenced models: List job openings — 200 response body — data item employment type Employment type details, List job openings — 200 response body — data item team Team details, List job openings — 200 response body — data item filled by application candidate, id, List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED, List job openings — 200 response body — data item location Location details
List job openings — 200 response body — data item employment type Employment type details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type details. |
id | string | Optional | Unique identifier of the employment type. Format: uuid |
name | string | Optional | Name of the employment type. |
List job openings — 200 response body — data item filled by application candidate, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application that filled this opening, including the hired candidate name. Null unless the opening is filled. |
candidate | JSON | Optional | Minimal identity of the hired candidate. |
candidate (anyOf 1) | Model | Alternative | Expand List job openings — 200 response body — data item filled by application candidate, id candidate Minimal identity of the hired candidate |
candidate (anyOf 2) | null | Alternative | |
id | string | Optional | ID of the application that filled this opening. Format: uuid |
Referenced models: List job openings — 200 response body — data item filled by application candidate, id candidate Minimal identity of the hired candidate
List job openings — 200 response body — data item filled by application candidate, id candidate Minimal identity of the hired candidate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Minimal identity of the hired candidate. |
first_name | string | Optional | First name of the hired candidate. |
last_name | string | Optional | Last name of the hired candidate. |
List job openings — 200 response body — data item location Location details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location details. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country code of the location. |
country (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code of the location. |
id | string | Optional | Unique identifier of the location. Format: uuid |
name | string | Optional | Name of the location. |
List job openings — 200 response body — data item team Team details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Team details. |
id | string | Optional | Unique identifier of the team. Format: uuid |
name | string | Optional | Name of the team. |
List the active approval options for offers — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Active approval options for offers |
data[] | Model | Each item | Expand List the active approval options for offers — 200 response body — data item |
has_more | boolean | Required within parent | Always false: every option is returned at once |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: every option is returned at once |
next_cursor (anyOf 2) | null | Alternative | Always null: every option is returned at once |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | number | Alternative | Number of options returned Format: double |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List the active approval options for offers — 200 response body — data item
List the active approval options for offers — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the approval policy or approval rule |
description (anyOf 2) | null | Alternative | Description of the approval policy or approval rule |
id | string | Required within parent | ID of the approval policy or approval rule Format: uuid |
name | string | Required within parent | Name of the approval policy or approval rule |
type | string | Required within parent | Whether the item is an approval policy or an approval rule, which decides the offer field its id goes in Known values: APPROVAL_POLICY, APPROVAL_RULE |
List the offer letter templates of the organization — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Offer letter templates that are not archived, most recently updated first |
data[] | Model | Each item | Expand List the offer letter templates of the organization — 200 response body — data item |
has_more | boolean | Required within parent | Always false: every template is returned at once |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: every template is returned at once |
next_cursor (anyOf 2) | null | Alternative | Always null: every template is returned at once |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | number | Alternative | Number of templates returned Format: double |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List the offer letter templates of the organization — 200 response body — data item
List the offer letter templates of the organization — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the template |
description (anyOf 2) | null | Alternative | Description of the template |
id | string | Required within parent | ID of the offer letter template Format: uuid |
name | string | Required within parent | Name of the template |
status | string | Required within parent | PUBLISHED templates are ready to use; DRAFT templates are still being edited Known values: PUBLISHED, DRAFT |
updated_at | string | Required within parent | Timestamp when the template was last updated Format: date-time |
List the private note of a job — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The private note of the job, or an empty list when the job has none. A job has at most one note. |
data[] | Model | Each item | Expand List the private note of a job — 200 response body — data item |
has_more | boolean | Required within parent | Always false: a job has at most one note. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: a job has at most one note. |
next_cursor (anyOf 2) | null | Alternative | Always null: a job has at most one note. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of notes on the job (0 or 1). |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List the private note of a job — 200 response body — data item
List the private note of a job — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The timestamp when the note was created Format: date-time |
created_by_hris_organization_user_id | JSON | Required within parent | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who created the note Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who created the note Format: uuid |
id | string | Required within parent | The unique identifier of the job note Format: uuid |
richtext_content | string | Required within parent | The content of the note in rich text HTML format |
updated_at | string | Required within parent | The timestamp when the note was last changed Format: date-time |
updated_by_hris_organization_user_id | JSON | Required within parent | |
updated_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who last changed the note Format: uuid |
updated_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who last changed the note Format: uuid |
Retrieve ATS Application form — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve ATS Application form — 200 response body — data |
Referenced models: Retrieve ATS Application form — 200 response body — data
Retrieve ATS Application form — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_confirmation_email_template_id | JSON | Required within parent | |
application_confirmation_email_template_id (anyOf 1) | string | Alternative | Unique identifier for the application confirmation email template Format: uuid |
application_confirmation_email_template_id (anyOf 2) | null | Alternative | Unique identifier for the application confirmation email template Format: uuid |
created_at | string | Required within parent | Timestamp when the application form was created Format: date-time |
demographic_option_types | array | Optional | Array of demographic option types for collecting diversity information |
demographic_option_types[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data demographic option types item |
demographic_section_helper_text | JSON | Required within parent | |
demographic_section_helper_text (anyOf 1) | string | Alternative | Helper text for the demographic section |
demographic_section_helper_text (anyOf 2) | null | Alternative | Helper text for the demographic section |
demographic_section_title | JSON | Required within parent | |
demographic_section_title (anyOf 1) | string | Alternative | Title for the demographic section |
demographic_section_title (anyOf 2) | null | Alternative | Title for the demographic section |
form_builder_form | JSON | Required within parent | Form builder configuration |
form_builder_form (anyOf 1) | Model | Alternative | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration |
form_builder_form (anyOf 2) | null | Alternative | |
form_builder_form_id | JSON | Required within parent | |
form_builder_form_id (anyOf 1) | string | Alternative | Unique identifier for the form builder form Format: uuid |
form_builder_form_id (anyOf 2) | null | Alternative | Unique identifier for the form builder form Format: uuid |
form_builder_form_revision_id | JSON | Required within parent | |
form_builder_form_revision_id (anyOf 1) | string | Alternative | Unique identifier for the form builder form revision Format: uuid |
form_builder_form_revision_id (anyOf 2) | null | Alternative | Unique identifier for the form builder form revision Format: uuid |
has_show_resume_field | boolean | Required within parent | Whether to show the resume field |
id | string | Required within parent | Unique identifier for the application form Format: uuid |
is_linkedin_profile_url_required | boolean | Required within parent | Whether the LinkedIn profile URL field is required |
is_location_city_field_required | boolean | Required within parent | Whether the city field is required, which is only required alongside the country field |
is_location_country_field_required | boolean | Required within parent | Whether the country field is required |
is_phone_number_required | boolean | Required within parent | Whether the phone number field is required |
is_resume_required | boolean | Required within parent | Whether the resume field is required |
organization_id | string | Required within parent | Unique identifier for the organization Format: uuid |
resume_field_helper_text | JSON | Required within parent | |
resume_field_helper_text (anyOf 1) | string | Alternative | Helper text for the resume field |
resume_field_helper_text (anyOf 2) | null | Alternative | Helper text for the resume field |
richtext_description | JSON | Required within parent | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the application form |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the application form |
sensitive_fields_ids | JSON | Required within parent | |
sensitive_fields_ids (anyOf 1) | array | Alternative | Array of sensitive field IDs |
sensitive_fields_ids (anyOf 1)[] | string | Each item | Format: uuid |
sensitive_fields_ids (anyOf 2) | null | Alternative | Array of sensitive field IDs |
sensitive_fields_ids (anyOf 2)[] | string | Each item | Format: uuid |
should_show_location_city_field | boolean | Required within parent | Whether to show the city field, which is only shown alongside the country field |
should_show_location_country_field | boolean | Required within parent | Whether to show the country field |
status_enum | string | Required within parent | Status of the application form Known values: DRAFT, PUBLISHED, ARCHIVED |
title | string | Required within parent | Title of the application form |
updated_at | string | Required within parent | Timestamp when the application form was last updated Format: date-time |
Referenced models: Retrieve ATS Application form — 200 response body — data demographic option types item, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration
Retrieve ATS Application form — 200 response body — data demographic option types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
helper_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Helper text for the option type |
helper_text (anyOf 2) | null | Alternative | Helper text for the option type |
id | string | Optional | Unique identifier for the demographic option type Format: uuid |
option_type_slug | string | Optional | Slug for the option type |
options | array | Optional | Array of available options for this demographic type |
options[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data demographic option types item options item |
Referenced models: Retrieve ATS Application form — 200 response body — data demographic option types item options item
Retrieve ATS Application form — 200 response body — data demographic option types item options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the option Format: uuid |
value | string | Optional | Value of the option |
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Form builder configuration |
pages | array | Required within parent | List of pages in the form |
pages[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item |
Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pages in the form |
sections | array | Required within parent | Sections within the page |
sections[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item |
title | string | Required within parent | Title of the form page |
Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sections within the page |
questions | array | Required within parent | List of questions within the section |
questions[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item |
subtitle | string | Optional | Additional information shown at the top of the section |
title | string | Required within parent | Title of the section |
Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of questions within the section |
date_limitation | JSON | Optional | |
date_limitation (anyOf 1) | string | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now |
date_limitation (anyOf 2) | null | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now |
default_value | JSON | Optional | |
default_value (anyOf 1) | string | Alternative | Default value to pre-fill in the form |
default_value (anyOf 2) | null | Alternative | Default value to pre-fill in the form |
has_request_validation | boolean | Optional | Whether additional validation should be triggered for this field |
helper_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Additional information to assist the user |
helper_text (anyOf 2) | null | Alternative | Additional information to assist the user |
is_disabled | boolean | Optional | If true, the field is disabled and cannot be edited |
is_multiple_selection | boolean | Optional | Indicates if the user can select multiple values |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions |
is_range | boolean | Optional | Specifies whether a date picker allows range selection |
is_required | boolean | Optional | Indicates if the question is required |
key | string | Optional | Unique key identifier for the question |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | Maximum character length for text responses |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | Maximum character length for text responses |
max_value | JSON | Optional | |
max_value (anyOf 1) | JSON | Alternative | |
max_value (anyOf 1) (anyOf 1) | number | Alternative | Maximum value allowed Format: double |
max_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_value (anyOf 2) | null | Alternative | Maximum value allowed Format: double |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum character length for text responses |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | Minimum character length for text responses |
min_value | JSON | Optional | |
min_value (anyOf 1) | JSON | Alternative | |
min_value (anyOf 1) (anyOf 1) | number | Alternative | Minimum value allowed Format: double |
min_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_value (anyOf 2) | null | Alternative | Minimum value allowed Format: double |
number_type | string | Optional | Used for number fields to define the unit or representation |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | List of selectable options for selection-type questions |
options (anyOf 1)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item |
options (anyOf 2) | null | Alternative | List of selectable options for selection-type questions |
options (anyOf 2)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item |
rules | JSON | Optional | |
rules (anyOf 1) | array | Alternative | Validation rules for the question |
rules (anyOf 1)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item |
rules (anyOf 2) | null | Alternative | Validation rules for the question |
rules (anyOf 2)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item |
source | JSON | Optional | Defines dynamic data source for the question |
source (anyOf 1) | Model | Alternative | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question |
source (anyOf 2) | null | Alternative | |
title | string | Required within parent | Title of the question |
type | string | Required within parent | Type of the question Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, ADDRESS, PHONENUMBER, DOCUMENTUPLOAD, NUMBER, DROPDOWN, DATEPICKER, EMAIL, CUSTOMDROPDOWN, PRESETDROPDOWN, NESTED |
Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | string | Required within parent | Display text for the option |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Value associated with the option |
value (anyOf 2) | null | Alternative | Value associated with the option |
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Validation rules for the question |
date_limitation | JSON | Optional | |
date_limitation (anyOf 1) | string | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now |
date_limitation (anyOf 2) | null | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now |
default_value | JSON | Optional | |
default_value (anyOf 1) | string | Alternative | Default value to pre-fill in the form |
default_value (anyOf 2) | null | Alternative | Default value to pre-fill in the form |
has_request_validation | boolean | Optional | Whether additional validation should be triggered for this field |
helper_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Additional information to assist the user |
helper_text (anyOf 2) | null | Alternative | Additional information to assist the user |
is_disabled | boolean | Optional | If true, the field is disabled and cannot be edited |
is_multiple_selection | boolean | Optional | Indicates if the user can select multiple values |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions |
is_range | boolean | Optional | Specifies whether a date picker allows range selection |
is_required | boolean | Optional | Indicates if the question is required |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | Maximum character length for text responses |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | Maximum character length for text responses |
max_value | JSON | Optional | |
max_value (anyOf 1) | JSON | Alternative | |
max_value (anyOf 1) (anyOf 1) | number | Alternative | Maximum value allowed Format: double |
max_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_value (anyOf 2) | null | Alternative | Maximum value allowed Format: double |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum character length for text responses |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | Minimum character length for text responses |
min_value | JSON | Optional | |
min_value (anyOf 1) | JSON | Alternative | |
min_value (anyOf 1) (anyOf 1) | number | Alternative | Minimum value allowed Format: double |
min_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_value (anyOf 2) | null | Alternative | Minimum value allowed Format: double |
number_type | string | Optional | Used for number fields to define the unit or representation |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 1)[] | JSON | Each item | Any type |
options (anyOf 2) | null | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 2)[] | JSON | Each item | Any type |
requires | array | Optional | List of conditions that must be met for this rule to apply |
requires[] | JSON | Each item | Any type |
source | JSON | Optional | Defines dynamic data source for the question |
source (anyOf 1) | Model | Alternative | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question |
source (anyOf 2) | null | Alternative | |
title | string | Optional | Title of the question |
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines dynamic data source for the question |
definition | string | Optional | Reference URL for API documentation |
description | string | Optional | Description of the data source |
url | string | Optional | API endpoint providing dynamic options |
Retrieve ATS email template tokens — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Placeholder tokens available in email templates. |
data[] | Model | Each item | Expand Retrieve ATS email template tokens — 200 response body — data item |
has_more | boolean | Required within parent | Always false: the catalogue is returned in full. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: the catalogue is returned in full. |
next_cursor (anyOf 2) | null | Alternative | Always null: the catalogue is returned in full. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of tokens in data. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve ATS email template tokens — 200 response body — data item
Retrieve ATS email template tokens — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Required within parent | What the token resolves from Known values: CANDIDATE, SENDER, ORGANIZATION, OFFER, INTERVIEW, QUESTIONNAIRE, APPLICATION_FORM, REFERRER, DOCUMENT |
code | string | Required within parent | Placeholder as written in a template subject or body |
id | string | Required within parent | Unique identifier of the token Format: uuid |
label | string | Required within parent | Human-readable name of the token |
Retrieve ATS job — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve ATS job — 200 response body — data |
Referenced models: Retrieve ATS job — 200 response body — data