Deel: Retrieve ATS application
Deel atsApplications.retrieveAtsApplication: arguments, response, policy and SDK examples.
← ATS applications operations · Get started
Operation deel.atsapplications_retrieveatsapplication_v2026_01_01
Provider route: GET /ats/applications/{application_id}. 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["atsApplications"]["retrieveAtsApplication"]>[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.atsApplications.retrieveAtsApplication(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_applications.retrieve_ats_application(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.application_id | string | Required within parent | 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 Retrieve ATS application — 200 response body |
Referenced models: Retrieve ATS application — 200 response body
Schemas
Section titled “Schemas”16 more schemas are linked from the tables above, on the schema pages.
Retrieve ATS application — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Single application response |
data | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data Complete application details |
Referenced models: Retrieve ATS application — 200 response body — data
Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Archivation reason details; null unless archived |
id | string | Required within parent | Archivation reason identifier Format: uuid |
label | string | Required within parent | Archivation reason label |
Retrieve ATS application — 200 response body — data job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job details |
id | string | Required within parent | Unique identifier for the job Format: uuid |
title | string | Required within parent | Title of the job |
Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type associated with the application |
employment_type | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type Employment type metadata |
id | string | Required within parent | Identifier of the job employment type record Format: uuid |
Referenced models: Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type
Retrieve ATS application — 200 response body — data job posting Job posting details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting details |
id | string | Required within parent | Unique identifier for the job posting Format: uuid |
title | string | Required within parent | Title of the job posting |
Retrieve ATS application — 200 response body — data job posting publication Job posting publication details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting publication details |
id | string | Required within parent | Job posting publication unique identifier Format: uuid |
Retrieve ATS application — 200 response body — data notes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Note associated with the application |
created_at | string | Required within parent | Timestamp when the note was created Format: date-time |
created_by | string | Required within parent | Unique identifier for the user who created the note Format: uuid |
id | string | Required within parent | Unique identifier for the note Format: uuid |
richtext_content | string | Required within parent | Rich text content of the note |
updated_at | string | Required within parent | Timestamp when the note was last updated Format: date-time |
Retrieve ATS application — 200 response body — data all application interview plan stages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entered_at | string | Required within parent | Timestamp when the application entered this stage Format: date-time |
exited_at | JSON | Required within parent | |
exited_at (anyOf 1) | string | Alternative | Timestamp when the application left this stage; null while the application is still in it Format: date-time |
exited_at (anyOf 2) | null | Alternative | Timestamp when the application left this stage; null while the application is still in it Format: date-time |
id | string | Required within parent | Unique identifier for the application interview plan stage Format: uuid |
interview_plan_stage | JSON | Required within parent | |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number |
interview_plan_stage (anyOf 2) | null | Alternative | |
is_current | boolean | Required within parent | Whether this is the stage the application is currently in |
moved_by_hris_organization_user_id | JSON | Required within parent | |
moved_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user who moved the application into this stage; null for automated moves Format: uuid |
moved_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user who moved the application into this stage; null for automated moves Format: uuid |
offers | array | Required within parent | Array of offers associated with this stage |
offers[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item offers item |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Timestamp when the stage was last updated Format: date-time |
updated_at (anyOf 2) | null | Alternative | Timestamp when the stage was last updated Format: date-time |
Referenced models: Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number, Retrieve ATS application — 200 response body — data all application interview plan stages item offers item
Retrieve ATS application — 200 response body — data application automation rule executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application automation rule execution |
action_type_enum | string | Required within parent | Type of action to execute Known values: ADD_CANDIDATE_TAG, TRANSITION_APPLICATION |
application_automation_rule_id | string | Required within parent | Automation rule identifier Format: uuid |
evaluation_result | array | Required within parent | Array of evaluation results |
evaluation_result[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item |
id | string | Required within parent | Unique identifier for the automation rule execution Format: uuid |
Referenced models: Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item
Retrieve ATS application — 200 response body — data application form submission answers, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application form submission data with mapped answers |
answers | array | Required within parent | Array of question answers with parsed data |
answers[] | Model | Each item | Expand Retrieve ATS application — 200 response body — data application form submission answers, id answers item |
id | string | Required within parent | Identifier of the application form submission Format: uuid |
Referenced models: Retrieve ATS application — 200 response body — data application form submission answers, id answers item
Retrieve ATS application — 200 response body — data application job criterias matchings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Match description |
id | string | Required within parent | Job criteria matching identifier Format: uuid |
is_matched | string | Required within parent | Match status Known values: MATCHED, NOT_MATCHED, UNDECIDED |
job_criteria | Model | Required within parent | Expand Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria |
Referenced models: Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria
Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current interview plan stage for the application |
id | string | Required within parent | Identifier of the application interview plan stage record Format: uuid |
interview_plan_stage | JSON | Required within parent | |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number |
interview_plan_stage (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atsapplications_retrieveatsapplication_v2026_01_01. Catalog operation: atsapplications_retrieveatsapplication_v2026_01_01. 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"}