Deel: Retrieve a list of ATS jobs
Deel atsJobs.retrieveAlistOfAtsJobs: arguments, response, policy and SDK examples.
← ATS jobs operations · Get started
Operation deel.atsjobs_retrievealistofatsjobs
Provider route: GET /ats/jobs. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["atsJobs"]["retrieveAlistOfAtsJobs"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.atsJobs.retrieveAlistOfAtsJobs(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.ats_jobs.retrieve_alist_of_ats_jobs(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.search | string | Optional | |
query.job_ids | array | Optional | |
query.job_ids[] | string | Each item | Format: uuid |
query.interview_plan_id | string | Optional | Format: uuid |
query.location_ids | array | Optional | |
query.location_ids[] | string | Each item | Format: uuid |
query.team_ids | array | Optional | |
query.team_ids[] | string | Each item | Format: uuid |
query.employment_type_ids | array | Optional | |
query.employment_type_ids[] | string | Each item | Format: uuid |
query.department_ids | array | Optional | |
query.department_ids[] | string | Each item | Format: uuid |
query.updated_after | string | Optional | Format: date-time |
query.status | array | Optional | |
query.status[] | string | Each item | One of: OPEN, PAUSED, CLOSED, DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED |
query.opened_after | string | Optional | Format: date-time |
query.opened_before | string | Optional | Format: date-time |
query.closed_after | string | Optional | Format: date-time |
query.closed_before | string | Optional | Format: date-time |
query.hiring_member_hou_ids | array | Optional | |
query.hiring_member_hou_ids[] | string | Each item | Format: uuid |
query.work_arrangements | array | Optional | |
query.work_arrangements[] | string | Each item | One of: ON_SITE, HYBRID, REMOTE |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve a list of ATS jobs — 200 response body |
Referenced models: Retrieve a list of ATS jobs — 200 response body
Schemas
Section titled “Schemas”13 more schemas are linked from the tables above, on the schema pages.
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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atsjobs_retrievealistofatsjobs. Catalog operation: atsjobs_retrievealistofatsjobs. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["ats:read", "worker:read"]
Pinned headers: {"X-Version": "2026-01-01"}