Deel: ATS jobs schemas
14 Deel schemas with complete fields and constraints.
← ATS jobs operations · All schemas
Create ATS Job — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create ATS Job — 201 response body — data |
Referenced models: Create ATS Job — 201 response body — data
Create ATS Job — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_request_id | JSON | Required within parent | |
approval_request_id (anyOf 1) | string | Alternative | ID of the approval request for this job Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | ID of the approval request for this job Format: uuid |
approval_rule_id | JSON | Required within parent | |
approval_rule_id (anyOf 1) | string | Alternative | ID of the approval rule applied to this job Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | ID of the approval rule applied to this job Format: uuid |
created_at | string | Optional | Timestamp when the job 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 | ID of the user who created the job Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | ID of the user who created the job Format: uuid |
id | string | Required within parent | Unique identifier for the created job Format: uuid |
is_confidential | boolean | Required within parent | Whether the job posting is confidential |
job_departments | JSON | Optional | |
job_departments (anyOf 1) | array | Alternative | Departments associated with the job |
job_departments (anyOf 1)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_departments (anyOf 2) | null | Alternative | Departments associated with the job |
job_departments (anyOf 2)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_employment_types | array | Required within parent | Employment types associated with the job |
job_employment_types[] | Model | Each item | Expand Create ATS Job — 201 response body — data job employment types item |
job_locations | array | Required within parent | Locations associated with the job |
job_locations[] | Model | Each item | Expand Create ATS Job — 201 response body — data job locations item |
job_teams | array | Required within parent | Teams associated with the job |
job_teams[] | Model | Each item | Expand Create ATS Job — 201 response body — data job teams item |
richtext_description | JSON | Optional | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the job |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the job |
status | string | Required within parent | Current status of the job Known values: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, CLOSED, ARCHIVED |
title | string | Required within parent | The job title |
updated_at | string | Optional | Timestamp when the job was last updated Format: date-time |
work_arrangement_enum | JSON | Optional | Work arrangement of the job. Null when unspecified. |
work_arrangement_enum (anyOf 1) | string | Alternative | Work arrangement of the job. Null when unspecified. Known values: ON_SITE, HYBRID, REMOTE |
work_arrangement_enum (anyOf 2) | null | Alternative |
Referenced models: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | JSON | Required within parent | |
department (anyOf 1) | Model | Alternative | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name |
department (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the department Format: uuid |
name | string | Required within parent | Department name |
Create ATS Job — 201 response body — data job employment types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_type | Model | Required within parent | Expand Create ATS Job — 201 response body — data job employment types item employment type |
id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the employment type Format: uuid |
name | string | Required within parent | Employment type name |
Create ATS Job — 201 response body — data job locations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job location Format: uuid |
location | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the location Format: uuid |
name | string | Required within parent | Location name |
Create ATS Job — 201 response body — data job teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job team Format: uuid |
team | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the team Format: uuid |
name | string | Required within parent | Team name |
Create ATS Job — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_ids | array | Optional | Array of department IDs (optional) |
department_ids[] | string | Each item | Format: uuid |
employment_type_ids | array | Required within parent | Array of employment type IDs (at least one required) |
employment_type_ids[] | string | Each item | Format: uuid |
interview_plan_id | string | Required within parent | Interview Plan ID must be a valid UUID Format: uuid |
is_confidential | boolean | Optional | Whether the job posting is confidential Default: false |
location_ids | array | Required within parent | Array of location IDs (at least one required) |
location_ids[] | string | Each item | Format: uuid |
richtext_description | string or null | Optional | Rich text description of the job Maximum length: 20000 |
status | string | Optional | Initial 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_ids | array | Required within parent | Array of team IDs (at least one required) |
team_ids[] | string | Each item | Format: uuid |
title | string | Required within parent | The job title Maximum length: 100 Minimum length: 1 |
work_arrangement_enum | JSON | Optional | Work arrangement of the job. Omit or send null to leave it unspecified. |
work_arrangement_enum (oneOf 1) | string | Alternative | Work arrangement of the job. Omit or send null to leave it unspecified. One of: ON_SITE, HYBRID, REMOTE |
work_arrangement_enum (oneOf 2) | null | Alternative |
Retrieve a list of ATS jobs — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of jobs. |
data[] | Model | Each item | Expand Retrieve a list of ATS jobs — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page; null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page; null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of jobs matching filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_pause_period | JSON | Optional | The pause currently in effect. Set only when status is PAUSED; null otherwise. |
active_pause_period (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data active pause period id, paused at |
active_pause_period (anyOf 2) | null | Alternative | |
applications_count | JSON | Optional | |
applications_count (anyOf 1) | JSON | Alternative | |
applications_count (anyOf 1) (anyOf 1) | integer | Alternative | Number of applications for the job |
applications_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
applications_count (anyOf 2) | null | Alternative | Number of applications for the job |
approval_request_id | JSON | Optional | |
approval_request_id (anyOf 1) | string | Alternative | Unique identifier for the approval request Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | Unique identifier for the approval request Format: uuid |
approval_request_stringified | JSON | Optional | |
approval_request_stringified (anyOf 1) | string | Alternative | Stringified approval request |
approval_request_stringified (anyOf 2) | null | Alternative | Stringified approval request |
approval_rule_id | JSON | Optional | |
approval_rule_id (anyOf 1) | string | Alternative | Unique identifier for the approval rule Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | Unique identifier for the approval rule Format: uuid |
closed_at | JSON | Optional | |
closed_at (anyOf 1) | string | Alternative | When the job was closed. Null when it is not closed. Format: date-time |
closed_at (anyOf 2) | null | Alternative | When the job was closed. Null when it is not closed. Format: date-time |
created_at | string | Optional | Timestamp when the job was created Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | Unique identifier of the user who created the job Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | Unique identifier of the user who created the job Format: uuid |
current_compensation | JSON | Optional | |
current_compensation (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY |
current_compensation (anyOf 2) | null | Alternative | |
hiring_member_job_permissions_by_type_slug | JSON | Optional | |
hiring_member_job_permissions_by_type_slug (anyOf 1) | Model | Alternative | Expand Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting |
hiring_member_job_permissions_by_type_slug (anyOf 2) | null | Alternative | |
hiring_members | JSON | Optional | |
hiring_members (anyOf 1) | array | Alternative | Hiring members associated with the job |
hiring_members (anyOf 1)[] | Model | Each item | Expand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item |
hiring_members (anyOf 2) | null | Alternative | Hiring members associated with the job |
hiring_members (anyOf 2)[] | Model | Each item | Expand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item |
id | string | Optional | Unique identifier for the job Format: uuid |
interview_plan_stages | JSON | Optional | |
interview_plan_stages (anyOf 1) | array | Alternative | Interview plan stages |
interview_plan_stages (anyOf 1)[] | Model | Each item | Expand Retrieve a list of ATS jobs — 200 response body — data item interview plan stages Interview plan stages item |
interview_plan_stages (anyOf 2) | null | Alternative | Interview plan stages |
interview_plan_stages (anyOf 2)[] | Model | Each item | Expand Retrieve a list of ATS jobs — 200 response body — data item interview plan stages Interview plan stages item |
is_confidential | boolean | Optional | Indicates if the job is confidential |
job_departments | JSON | Optional | |
job_departments (anyOf 1) | array | Alternative | Departments associated with the job |
job_departments (anyOf 1)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_departments (anyOf 2) | null | Alternative | Departments associated with the job |
job_departments (anyOf 2)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_employment_types | array | Optional | Employment types associated with the job |
job_employment_types[] | Model | Each item | Expand Create ATS Job — 201 response body — data job employment types item |
job_locations | array | Optional | Locations associated with the job |
job_locations[] | Model | Each item | Expand Create ATS Job — 201 response body — data job locations item |
job_teams | JSON | Optional | |
job_teams (anyOf 1) | array | Alternative | Teams associated with the job |
job_teams (anyOf 1)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job teams item |
job_teams (anyOf 2) | null | Alternative | Teams associated with the job |
job_teams (anyOf 2)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job teams item |
opened_at | JSON | Optional | |
opened_at (anyOf 1) | string | Alternative | When the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened. Format: date-time |
opened_at (anyOf 2) | null | Alternative | When the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened. Format: date-time |
richtext_description | JSON | Optional | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the job |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the job |
status | string | Optional | Job status. PAUSED jobs are open but temporarily not accepting candidates; see active_pause_period. Known values: OPEN, PAUSED, CLOSED, DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED |
title | string | Optional | Job title |
updated_at | string | Optional | Timestamp when the job was last updated Format: date-time |
work_arrangement_enum | JSON | Optional | Work arrangement of the job. Null when unspecified. |
work_arrangement_enum (anyOf 1) | string | Alternative | Work arrangement of the job. Null when unspecified. Known values: ON_SITE, HYBRID, REMOTE |
work_arrangement_enum (anyOf 2) | null | Alternative |
Referenced models: Retrieve ATS job — 200 response body — data active pause period id, paused at, Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting, Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item, Create ATS Job — 201 response body — data job employment types item, Create ATS Job — 201 response body — data job locations item, Create ATS Job — 201 response body — data job teams item, Retrieve ATS job — 200 response body — data / 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_type_slug | string | Optional | Category type of the interview plan stage Known values: LEAD, ACTIVE, COMPLETED |
default_type_slug | JSON | Optional | |
default_type_slug (anyOf 1) | string | Alternative | Default type slug of the interview plan stage |
default_type_slug (anyOf 2) | null | Alternative | Default type slug of the interview plan stage |
id | string | Optional | Unique identifier for the interview plan stage Format: uuid |
interview_plan_id | string | Optional | Interview plan ID associated with this stage Format: uuid |
name | string | Optional | Interview plan stage name |
position_number | JSON | Optional | |
position_number (anyOf 1) | JSON | Alternative | |
position_number (anyOf 1) (anyOf 1) | integer | Alternative | Position number of the stage in the interview plan |
position_number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
position_number (anyOf 2) | null | Alternative | Position number of the stage in the interview plan |