Skip to content

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.

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 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_applications.retrieve_ats_application(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.application_idstringRequired within parentFormat: uuid

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 application — 200 response body

Referenced models: Retrieve ATS application — 200 response body

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

Retrieve ATS application — 200 response body
FieldTypePresenceDescription and constraints
$objectRootSingle application response
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootArchivation reason details; null unless archived
idstringRequired within parentArchivation reason identifier
Format: uuid
labelstringRequired within parentArchivation reason label
Retrieve ATS application — 200 response body — data job
FieldTypePresenceDescription and constraints
$objectRootJob details
idstringRequired within parentUnique identifier for the job
Format: uuid
titlestringRequired within parentTitle of the job
Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application
FieldTypePresenceDescription and constraints
$objectRootEmployment type associated with the application
employment_typeModelRequired within parentExpand Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type
Employment type metadata
idstringRequired within parentIdentifier 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
FieldTypePresenceDescription and constraints
$objectRootJob posting details
idstringRequired within parentUnique identifier for the job posting
Format: uuid
titlestringRequired within parentTitle of the job posting
Retrieve ATS application — 200 response body — data job posting publication Job posting publication details
FieldTypePresenceDescription and constraints
$objectRootJob posting publication details
idstringRequired within parentJob posting publication unique identifier
Format: uuid
Retrieve ATS application — 200 response body — data notes item
FieldTypePresenceDescription and constraints
$objectRootNote associated with the application
created_atstringRequired within parentTimestamp when the note was created
Format: date-time
created_bystringRequired within parentUnique identifier for the user who created the note
Format: uuid
idstringRequired within parentUnique identifier for the note
Format: uuid
richtext_contentstringRequired within parentRich text content of the note
updated_atstringRequired within parentTimestamp when the note was last updated
Format: date-time
Retrieve ATS application — 200 response body — data all application interview plan stages item
FieldTypePresenceDescription and constraints
$objectRoot
entered_atstringRequired within parentTimestamp when the application entered this stage
Format: date-time
exited_atJSONRequired within parent
exited_at (anyOf 1)stringAlternativeTimestamp when the application left this stage; null while the application is still in it
Format: date-time
exited_at (anyOf 2)nullAlternativeTimestamp when the application left this stage; null while the application is still in it
Format: date-time
idstringRequired within parentUnique identifier for the application interview plan stage
Format: uuid
interview_plan_stageJSONRequired within parent
interview_plan_stage (anyOf 1)ModelAlternativeExpand 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)nullAlternative
is_currentbooleanRequired within parentWhether this is the stage the application is currently in
moved_by_hris_organization_user_idJSONRequired within parent
moved_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user who moved the application into this stage; null for automated moves
Format: uuid
moved_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user who moved the application into this stage; null for automated moves
Format: uuid
offersarrayRequired within parentArray of offers associated with this stage
offers[]ModelEach itemExpand Retrieve ATS application — 200 response body — data all application interview plan stages item offers item
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeTimestamp when the stage was last updated
Format: date-time
updated_at (anyOf 2)nullAlternativeTimestamp 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
FieldTypePresenceDescription and constraints
$objectRootApplication automation rule execution
action_type_enumstringRequired within parentType of action to execute
Known values: ADD_CANDIDATE_TAG, TRANSITION_APPLICATION
application_automation_rule_idstringRequired within parentAutomation rule identifier
Format: uuid
evaluation_resultarrayRequired within parentArray of evaluation results
evaluation_result[]ModelEach itemExpand Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item
idstringRequired within parentUnique 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
FieldTypePresenceDescription and constraints
$objectRootApplication form submission data with mapped answers
answersarrayRequired within parentArray of question answers with parsed data
answers[]ModelEach itemExpand Retrieve ATS application — 200 response body — data application form submission answers, id answers item
idstringRequired within parentIdentifier 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
FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentMatch description
idstringRequired within parentJob criteria matching identifier
Format: uuid
is_matchedstringRequired within parentMatch status
Known values: MATCHED, NOT_MATCHED, UNDECIDED
job_criteriaModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootCurrent interview plan stage for the application
idstringRequired within parentIdentifier of the application interview plan stage record
Format: uuid
interview_plan_stageJSONRequired within parent
interview_plan_stage (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

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

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.