Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalMaximum: 100
Minimum: 1
query.statusarrayOptional
query.status[]stringEach itemOne of: DRAFT, OPEN, FILLED, CLOSED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED
query.team_idsarrayOptional
query.team_ids[]stringEach itemFormat: uuid
query.location_idsarrayOptional
query.location_ids[]stringEach itemFormat: uuid
query.job_idsarrayOptional
query.job_ids[]stringEach itemFormat: uuid
query.tag_idsarrayOptional
query.tag_ids[]stringEach itemFormat: uuid
query.tag_ids_operatorstringOptionalOne of: ANY, ALL
query.recruiter_hris_organization_user_idsarrayOptional
query.recruiter_hris_organization_user_ids[]stringEach itemFormat: uuid
query.created_by_hris_organization_user_idsarrayOptional
query.created_by_hris_organization_user_ids[]stringEach itemFormat: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List job openings — 200 response body

Referenced models: List job openings — 200 response body

4 more schemas are linked from the tables above, on the schema pages.

List job openings — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of openings.
data[]ModelEach itemExpand List job openings — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 openings matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
compensation_currency_iso_codeJSONOptional
compensation_currency_iso_code (anyOf 1)stringAlternativeISO 4217 currency code for compensation.
compensation_currency_iso_code (anyOf 2)nullAlternativeISO 4217 currency code for compensation.
compensation_periodJSONOptional
compensation_period (anyOf 1)stringAlternativeCompensation period (e.g. yearly, monthly).
compensation_period (anyOf 2)nullAlternativeCompensation period (e.g. yearly, monthly).
created_atstringRequired within parentISO 8601 datetime when the opening was created.
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who created this opening.
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who created this opening.
Format: uuid
employment_typeJSONOptionalEmployment type details.
employment_type (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item employment type Employment type details
employment_type (anyOf 2)nullAlternative
employment_type_idJSONOptional
employment_type_id (anyOf 1)stringAlternativeID of the employment type associated with the opening.
Format: uuid
employment_type_id (anyOf 2)nullAlternativeID of the employment type associated with the opening.
Format: uuid
filled_atJSONOptional
filled_at (anyOf 1)stringAlternativeWhen the opening was filled. Null while it is unfilled.
Format: date-time
filled_at (anyOf 2)nullAlternativeWhen the opening was filled. Null while it is unfilled.
Format: date-time
filled_by_applicationJSONOptionalThe application that filled this opening, including the hired candidate name. Null unless the opening is filled.
filled_by_application (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item filled by application candidate, id
filled_by_application (anyOf 2)nullAlternative
filled_by_application_idJSONOptional
filled_by_application_id (anyOf 1)stringAlternativeID of the application that filled this opening, if any.
Format: uuid
filled_by_application_id (anyOf 2)nullAlternativeID of the application that filled this opening, if any.
Format: uuid
filled_by_offerJSONOptionalThe 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)ModelAlternativeExpand List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED
filled_by_offer (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the opening.
Format: uuid
is_confidentialbooleanOptionalWhether this opening is marked confidential.
job_idsarrayOptionalIDs of jobs linked to this opening.
job_ids[]stringEach itemFormat: uuid
locationJSONOptionalLocation details.
location (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item location Location details
location (anyOf 2)nullAlternative
location_idJSONOptional
location_id (anyOf 1)stringAlternativeID of the location associated with the opening.
Format: uuid
location_id (anyOf 2)nullAlternativeID of the location associated with the opening.
Format: uuid
max_compensation_amountJSONOptional
max_compensation_amount (anyOf 1)stringAlternativeMaximum compensation amount as a decimal string.
max_compensation_amount (anyOf 2)nullAlternativeMaximum compensation amount as a decimal string.
min_compensation_amountJSONOptional
min_compensation_amount (anyOf 1)stringAlternativeMinimum compensation amount as a decimal string.
min_compensation_amount (anyOf 2)nullAlternativeMinimum compensation amount as a decimal string.
opened_atJSONOptional
opened_at (anyOf 1)stringAlternativeWhen the opening was last opened. Reset when the opening is reopened. Null when it was never opened.
Format: date-time
opened_at (anyOf 2)nullAlternativeWhen the opening was last opened. Reset when the opening is reopened. Null when it was never opened.
Format: date-time
opening_numeric_idJSONRequired within parent
opening_numeric_id (anyOf 1)integerAlternativeNumeric part of the opening identifier (e.g. 42 in ENG-42).
opening_numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
opening_prefixstringRequired within parentPrefix of the opening identifier (e.g. ENG in ENG-42).
opening_type_slugstringRequired within parentWhether this opening is for a new hire or a backfill.
Known values: NEW_HIRE, BACKFILL
recruiter_hris_organization_user_idJSONOptional
recruiter_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the recruiter responsible for the opening. Null when none is assigned.
Format: uuid
recruiter_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the recruiter responsible for the opening. Null when none is assigned.
Format: uuid
statusstringRequired within parentCurrent lifecycle status of the opening.
Known values: DRAFT, OPEN, FILLED, CLOSED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED
target_hire_dateJSONOptional
target_hire_date (anyOf 1)stringAlternativeTarget date by which the opening should be filled (ISO 8601).
Format: date-time
target_hire_date (anyOf 2)nullAlternativeTarget date by which the opening should be filled (ISO 8601).
Format: date-time
target_start_dateJSONOptional
target_start_date (anyOf 1)stringAlternativeTarget start date for the new hire (ISO 8601).
Format: date-time
target_start_date (anyOf 2)nullAlternativeTarget start date for the new hire (ISO 8601).
Format: date-time
teamJSONOptionalTeam details.
team (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item team Team details
team (anyOf 2)nullAlternative
team_idJSONOptional
team_id (anyOf 1)stringAlternativeID of the team this opening belongs to.
Format: uuid
team_id (anyOf 2)nullAlternativeID of the team this opening belongs to.
Format: uuid
titlestringRequired within parentTitle of the job opening.
updated_atstringRequired within parentISO 8601 datetime when the opening was last updated.
Format: date-time
updated_by_hris_organization_user_idJSONOptional
updated_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who last updated this opening.
Format: uuid
updated_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS 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
FieldTypePresenceDescription and constraints
$objectRootEmployment type details.
idstringOptionalUnique identifier of the employment type.
Format: uuid
namestringOptionalName of the employment type.
List job openings — 200 response body — data item team Team details
FieldTypePresenceDescription and constraints
$objectRootTeam details.
idstringOptionalUnique identifier of the team.
Format: uuid
namestringOptionalName of the team.

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"}

Official provider source

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.