Skip to content

Deel: Retrieve ATS job

Deel ats.retrieveAtsJob: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_retrieveatsjob_v2026_10_28

Provider route: GET /ats/jobs/{job_id}. 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"]["retrieveAtsJob"]>[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.retrieveAtsJob(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.retrieve_ats_job(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.job_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve ATS job — 200 response body

Referenced models: Retrieve ATS job — 200 response body

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

Retrieve ATS job — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve ATS job — 200 response body — data

Referenced models: Retrieve ATS job — 200 response body — data

Retrieve ATS job — 200 response body — data
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_requestJSONRequired within parentApproval request for the job. Null when the job never went through approval.
approval_request (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at
approval_request (anyOf 2)nullAlternative
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_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
closure_reasonJSONRequired within parentWhy the job was closed. Null when the job is not closed or no reason was recorded.
closure_reason (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data closure reason id, name
closure_reason (anyOf 2)nullAlternative
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
idstringRequired within parentUnique identifier for the job
Format: uuid
interview_plan_stagesarrayRequired within parentInterview plan stages that currently hold at least one application, ordered by position.
interview_plan_stages[]ModelEach itemExpand Retrieve ATS job — 200 response body — data 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
statusstringRequired within parentJob 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
titlestringRequired within parentJob 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 closure reason id, name, Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY, Create ATS Job — 201 response body — data job departments Departments associated with the job item, Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at, Retrieve ATS job — 200 response body — data interview plan stages item

Retrieve ATS job — 200 response body — data active pause period id, paused at
FieldTypePresenceDescription and constraints
$objectRootThe pause currently in effect. Set only when status is PAUSED; null otherwise.
idstringRequired within parentUnique identifier of the pause period
Format: uuid
paused_atstringRequired within parentWhen the job was paused
Format: date-time

SDK function policy ID: deel.ats_retrieveatsjob_v2026_10_28. Catalog operation: ats_retrieveatsjob_v2026_10_28. 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-10-28"}

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.