Deel: List job openings
Deel ats.listOpenings: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_listopenings_v2026_06_15
Provider route: GET /ats/openings. 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["ats"]["listOpenings"]>[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.ats.listOpenings(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.list_openings(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 | Maximum: 100 Minimum: 1 |
query.status | array | Optional | |
query.status[] | string | Each item | One of: DRAFT, OPEN, FILLED, CLOSED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED |
query.team_ids | array | Optional | |
query.team_ids[] | string | Each item | Format: uuid |
query.location_ids | array | Optional | |
query.location_ids[] | string | Each item | Format: uuid |
query.job_ids | array | Optional | |
query.job_ids[] | string | Each item | Format: uuid |
query.tag_ids | array | Optional | |
query.tag_ids[] | string | Each item | Format: uuid |
query.tag_ids_operator | string | Optional | One of: ANY, ALL |
query.recruiter_hris_organization_user_ids | array | Optional | |
query.recruiter_hris_organization_user_ids[] | string | Each item | Format: uuid |
query.created_by_hris_organization_user_ids | array | Optional | |
query.created_by_hris_organization_user_ids[] | string | Each item | Format: uuid |
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 List job openings — 200 response body |
Referenced models: List job openings — 200 response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
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
| 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 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_listopenings_v2026_06_15. Catalog operation: ats_listopenings_v2026_06_15. 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-06-15"}