Skip to content

Deel: ATS jobs schemas

14 Deel schemas with complete fields and constraints.

← ATS jobs operations · All schemas

Create ATS Job — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create ATS Job — 201 response body — data

Referenced models: Create ATS Job — 201 response body — data

Create ATS Job — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
approval_request_idJSONRequired within parent
approval_request_id (anyOf 1)stringAlternativeID of the approval request for this job
Format: uuid
approval_request_id (anyOf 2)nullAlternativeID of the approval request for this job
Format: uuid
approval_rule_idJSONRequired within parent
approval_rule_id (anyOf 1)stringAlternativeID of the approval rule applied to this job
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeID of the approval rule applied to this job
Format: uuid
created_atstringOptionalTimestamp when the job was created
Format: date-time
created_by_hris_organization_user_idJSONRequired within parent
created_by_hris_organization_user_id (anyOf 1)stringAlternativeID of the user who created the job
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeID of the user who created the job
Format: uuid
idstringRequired within parentUnique identifier for the created job
Format: uuid
is_confidentialbooleanRequired within parentWhether the job posting is confidential
job_departmentsJSONOptional
job_departments (anyOf 1)arrayAlternativeDepartments associated with the job
job_departments (anyOf 1)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_departments (anyOf 2)nullAlternativeDepartments associated with the job
job_departments (anyOf 2)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_employment_typesarrayRequired within parentEmployment types associated with the job
job_employment_types[]ModelEach itemExpand Create ATS Job — 201 response body — data job employment types item
job_locationsarrayRequired within parentLocations associated with the job
job_locations[]ModelEach itemExpand Create ATS Job — 201 response body — data job locations item
job_teamsarrayRequired within parentTeams associated with the job
job_teams[]ModelEach itemExpand Create ATS Job — 201 response body — data job teams item
richtext_descriptionJSONOptional
richtext_description (anyOf 1)stringAlternativeRich text description of the job
richtext_description (anyOf 2)nullAlternativeRich text description of the job
statusstringRequired within parentCurrent status of the job
Known values: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, CLOSED, ARCHIVED
titlestringRequired within parentThe job title
updated_atstringOptionalTimestamp when the job was last updated
Format: date-time
work_arrangement_enumJSONOptionalWork arrangement of the job. Null when unspecified.
work_arrangement_enum (anyOf 1)stringAlternativeWork arrangement of the job. Null when unspecified.
Known values: ON_SITE, HYBRID, REMOTE
work_arrangement_enum (anyOf 2)nullAlternative

Referenced models: Create ATS Job — 201 response body — data job employment types item, Create ATS Job — 201 response body — data job locations item, Create ATS Job — 201 response body — data job teams item, Create ATS Job — 201 response body — data job departments Departments associated with the job item

Create ATS Job — 201 response body — data job departments Departments associated with the job item

FieldTypePresenceDescription and constraints
$objectRoot
departmentJSONRequired within parent
department (anyOf 1)ModelAlternativeExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name
department (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the job department
Format: uuid

Referenced models: Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name

Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the department
Format: uuid
namestringRequired within parentDepartment name

Create ATS Job — 201 response body — data job employment types item

FieldTypePresenceDescription and constraints
$objectRoot
employment_typeModelRequired within parentExpand Create ATS Job — 201 response body — data job employment types item employment type
idstringRequired within parentUnique identifier for the job employment type
Format: uuid

Referenced models: Create ATS Job — 201 response body — data job employment types item employment type

Create ATS Job — 201 response body — data job employment types item employment type

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the employment type
Format: uuid
namestringRequired within parentEmployment type name

Create ATS Job — 201 response body — data job locations item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job location
Format: uuid
locationModelRequired within parentExpand Create ATS Job — 201 response body — data job locations item location

Referenced models: Create ATS Job — 201 response body — data job locations item location

Create ATS Job — 201 response body — data job locations item location

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the location
Format: uuid
namestringRequired within parentLocation name

Create ATS Job — 201 response body — data job teams item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job team
Format: uuid
teamModelRequired within parentExpand Create ATS Job — 201 response body — data job teams item team

Referenced models: Create ATS Job — 201 response body — data job teams item team

Create ATS Job — 201 response body — data job teams item team

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the team
Format: uuid
namestringRequired within parentTeam name

Create ATS Job — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
department_idsarrayOptionalArray of department IDs (optional)
department_ids[]stringEach itemFormat: uuid
employment_type_idsarrayRequired within parentArray of employment type IDs (at least one required)
employment_type_ids[]stringEach itemFormat: uuid
interview_plan_idstringRequired within parentInterview Plan ID must be a valid UUID
Format: uuid
is_confidentialbooleanOptionalWhether the job posting is confidential
Default: false
location_idsarrayRequired within parentArray of location IDs (at least one required)
location_ids[]stringEach itemFormat: uuid
richtext_descriptionstring or nullOptionalRich text description of the job
Maximum length: 20000
statusstringOptionalInitial status of the job. Defaults to the status derived from the applicable approval rule when omitted.
One of: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, CLOSED, ARCHIVED
team_idsarrayRequired within parentArray of team IDs (at least one required)
team_ids[]stringEach itemFormat: uuid
titlestringRequired within parentThe job title
Maximum length: 100
Minimum length: 1
work_arrangement_enumJSONOptionalWork arrangement of the job. Omit or send null to leave it unspecified.
work_arrangement_enum (oneOf 1)stringAlternativeWork arrangement of the job. Omit or send null to leave it unspecified.
One of: ON_SITE, HYBRID, REMOTE
work_arrangement_enum (oneOf 2)nullAlternative

Retrieve a list of ATS jobs — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of jobs.
data[]ModelEach itemExpand Retrieve a list of ATS jobs — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page; null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to fetch the next page; null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of jobs matching filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of ATS jobs — 200 response body — data item

Retrieve a list of ATS jobs — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
active_pause_periodJSONOptionalThe pause currently in effect. Set only when status is PAUSED; null otherwise.
active_pause_period (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data active pause period id, paused at
active_pause_period (anyOf 2)nullAlternative
applications_countJSONOptional
applications_count (anyOf 1)JSONAlternative
applications_count (anyOf 1) (anyOf 1)integerAlternativeNumber of applications for the job
applications_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
applications_count (anyOf 2)nullAlternativeNumber of applications for the job
approval_request_idJSONOptional
approval_request_id (anyOf 1)stringAlternativeUnique identifier for the approval request
Format: uuid
approval_request_id (anyOf 2)nullAlternativeUnique identifier for the approval request
Format: uuid
approval_request_stringifiedJSONOptional
approval_request_stringified (anyOf 1)stringAlternativeStringified approval request
approval_request_stringified (anyOf 2)nullAlternativeStringified approval request
approval_rule_idJSONOptional
approval_rule_id (anyOf 1)stringAlternativeUnique identifier for the approval rule
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeUnique identifier for the approval rule
Format: uuid
closed_atJSONOptional
closed_at (anyOf 1)stringAlternativeWhen the job was closed. Null when it is not closed.
Format: date-time
closed_at (anyOf 2)nullAlternativeWhen the job was closed. Null when it is not closed.
Format: date-time
created_atstringOptionalTimestamp when the job was created
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeUnique identifier of the user who created the job
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeUnique identifier of the user who created the job
Format: uuid
current_compensationJSONOptional
current_compensation (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY
current_compensation (anyOf 2)nullAlternative
hiring_member_job_permissions_by_type_slugJSONOptional
hiring_member_job_permissions_by_type_slug (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting
hiring_member_job_permissions_by_type_slug (anyOf 2)nullAlternative
hiring_membersJSONOptional
hiring_members (anyOf 1)arrayAlternativeHiring members associated with the job
hiring_members (anyOf 1)[]ModelEach itemExpand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item
hiring_members (anyOf 2)nullAlternativeHiring members associated with the job
hiring_members (anyOf 2)[]ModelEach itemExpand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item
idstringOptionalUnique identifier for the job
Format: uuid
interview_plan_stagesJSONOptional
interview_plan_stages (anyOf 1)arrayAlternativeInterview plan stages
interview_plan_stages (anyOf 1)[]ModelEach itemExpand Retrieve a list of ATS jobs — 200 response body — data item interview plan stages Interview plan stages item
interview_plan_stages (anyOf 2)nullAlternativeInterview plan stages
interview_plan_stages (anyOf 2)[]ModelEach itemExpand Retrieve a list of ATS jobs — 200 response body — data item interview plan stages Interview plan stages item
is_confidentialbooleanOptionalIndicates if the job is confidential
job_departmentsJSONOptional
job_departments (anyOf 1)arrayAlternativeDepartments associated with the job
job_departments (anyOf 1)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_departments (anyOf 2)nullAlternativeDepartments associated with the job
job_departments (anyOf 2)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_employment_typesarrayOptionalEmployment types associated with the job
job_employment_types[]ModelEach itemExpand Create ATS Job — 201 response body — data job employment types item
job_locationsarrayOptionalLocations associated with the job
job_locations[]ModelEach itemExpand Create ATS Job — 201 response body — data job locations item
job_teamsJSONOptional
job_teams (anyOf 1)arrayAlternativeTeams associated with the job
job_teams (anyOf 1)[]ModelEach itemExpand Create ATS Job — 201 response body — data job teams item
job_teams (anyOf 2)nullAlternativeTeams associated with the job
job_teams (anyOf 2)[]ModelEach itemExpand Create ATS Job — 201 response body — data job teams item
opened_atJSONOptional
opened_at (anyOf 1)stringAlternativeWhen the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened.
Format: date-time
opened_at (anyOf 2)nullAlternativeWhen the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened.
Format: date-time
richtext_descriptionJSONOptional
richtext_description (anyOf 1)stringAlternativeRich text description of the job
richtext_description (anyOf 2)nullAlternativeRich text description of the job
statusstringOptionalJob status. PAUSED jobs are open but temporarily not accepting candidates; see active_pause_period.
Known values: OPEN, PAUSED, CLOSED, DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED
titlestringOptionalJob title
updated_atstringOptionalTimestamp when the job was last updated
Format: date-time
work_arrangement_enumJSONOptionalWork arrangement of the job. Null when unspecified.
work_arrangement_enum (anyOf 1)stringAlternativeWork arrangement of the job. Null when unspecified.
Known values: ON_SITE, HYBRID, REMOTE
work_arrangement_enum (anyOf 2)nullAlternative

Referenced models: Retrieve ATS job — 200 response body — data active pause period id, paused at, Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting, Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item, Create ATS Job — 201 response body — data job employment types item, Create ATS Job — 201 response body — data job locations item, Create ATS Job — 201 response body — data job teams item, Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY, Retrieve a list of ATS jobs — 200 response body — data item interview plan stages Interview plan stages item, Create ATS Job — 201 response body — data job departments Departments associated with the job item

Retrieve a list of ATS jobs — 200 response body — data item interview plan stages Interview plan stages item

FieldTypePresenceDescription and constraints
$objectRoot
category_type_slugstringOptionalCategory type of the interview plan stage
Known values: LEAD, ACTIVE, COMPLETED
default_type_slugJSONOptional
default_type_slug (anyOf 1)stringAlternativeDefault type slug of the interview plan stage
default_type_slug (anyOf 2)nullAlternativeDefault type slug of the interview plan stage
idstringOptionalUnique identifier for the interview plan stage
Format: uuid
interview_plan_idstringOptionalInterview plan ID associated with this stage
Format: uuid
namestringOptionalInterview plan stage name
position_numberJSONOptional
position_number (anyOf 1)JSONAlternative
position_number (anyOf 1) (anyOf 1)integerAlternativePosition number of the stage in the interview plan
position_number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
position_number (anyOf 2)nullAlternativePosition number of the stage in the interview plan

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.