Skip to content

Deel: Retrieve a list of ATS applications

Deel atsApplications.retrieveAlistOfAtsApplications: arguments, response, policy and SDK examples.

← ATS applications operations · Get started

Operation deel.atsapplications_retrievealistofatsapplications_v2026_01_01

Provider route: GET /ats/applications. 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"]["retrieveAlistOfAtsApplications"]>[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.retrieveAlistOfAtsApplications(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_alist_of_ats_applications(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptionalMaximum length: 1000
query.limitintegerOptionalDefault: 20
Maximum: 500
Minimum: 1
query.search_textstringOptionalMaximum length: 500
query.job_idstringOptionalFormat: uuid
query.job_idsarrayOptional
query.job_ids[]stringEach itemFormat: uuid
query.hiring_member_hou_idsarrayOptional
query.hiring_member_hou_ids[]stringEach itemFormat: uuid
query.hiring_member_role_idsarrayOptional
query.hiring_member_role_ids[]integerEach item
query.interview_plan_stage_idsarrayOptional
query.interview_plan_stage_ids[]stringEach itemFormat: uuid
query.reached_interview_plan_stage_idsarrayOptional
query.reached_interview_plan_stage_ids[]stringEach itemFormat: uuid
query.moved_to_current_stage_beforestringOptionalFormat: date-time
query.archivation_reason_idsarrayOptional
query.archivation_reason_ids[]stringEach itemFormat: uuid
query.candidate_tag_ids_operatorstringOptionalOne of: ANY, ALL
query.includearrayOptional
query.include[]stringEach itemOne of: STAGE_HISTORY
query.candidate_tag_idsarrayOptional
query.candidate_tag_ids[]stringEach itemFormat: uuid
query.source_slugsarrayOptional
query.source_slugs[]stringEach item
query.job_criterias_matchingsarrayOptional
query.job_criterias_matchings[]ModelEach itemExpand Retrieve a list of ATS applications — request body — query job criterias matchings item
query.current_stage_category_type_slugsarrayOptional
query.current_stage_category_type_slugs[]stringEach itemMaximum length: 50
query.current_stage_default_type_slugsarrayOptional
query.current_stage_default_type_slugs[]stringEach itemMaximum length: 50
query.updated_afterstringOptionalFormat: date-time
query.sort_bystringOptionalOne of: APPLICATION_CREATION_DATE, STAGE_CREATION_DATE
query.sort_orderstringOptionalOne of: ASC, DESC

Referenced models: Retrieve a list of ATS applications — request body — query job criterias matchings item

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a list of ATS applications — 200 response body

Referenced models: Retrieve a list of ATS applications — 200 response body

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

Retrieve a list of ATS applications — request body — query job criterias matchings item
FieldTypePresenceDescription and constraints
$objectRoot
is_matchedstringRequired within parentOne of: MATCHED, NOT_MATCHED, UNDECIDED
job_criteria_idstringRequired within parentFormat: uuid
Retrieve a list of ATS applications — 200 response body
FieldTypePresenceDescription and constraints
$objectRootPaginated list of applications
dataarrayRequired within parentPage of applications
data[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available
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 applications
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of ATS applications — 200 response body — data item

Retrieve a list of ATS applications — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRootApplication object
application_form_form_builder_form_submission_idJSONOptional
application_form_form_builder_form_submission_id (anyOf 1)stringAlternativeApplication form submission unique identifier
Format: uuid
application_form_form_builder_form_submission_id (anyOf 2)nullAlternativeApplication form submission unique identifier
Format: uuid
application_form_submissionJSONOptionalApplication form submission data with parsed answers
application_form_submission (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id
application_form_submission (anyOf 2)nullAlternative
application_job_criterias_matchingsarrayOptionalAI-generated job criteria matching results for the application
application_job_criterias_matchings[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item
archivation_reason_idJSONOptional
archivation_reason_id (anyOf 1)stringAlternativeReason the application was archived; null unless archived
Format: uuid
archivation_reason_id (anyOf 2)nullAlternativeReason the application was archived; null unless archived
Format: uuid
candidateModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item candidate
Candidate information associated with the application
created_atstringRequired within parentTimestamp of when the application was created
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeUser who created the application
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeUser who created the application
Format: uuid
current_application_interview_plan_stageModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage
Current interview plan stage information for the application
current_application_interview_plan_stage_idJSONOptional
current_application_interview_plan_stage_id (anyOf 1)stringAlternativeCurrent interview plan stage unique identifier
Format: uuid
current_application_interview_plan_stage_id (anyOf 2)nullAlternativeCurrent interview plan stage unique identifier
Format: uuid
hired_atJSONOptional
hired_at (anyOf 1)stringAlternativeTimestamp when the application reached the hired stage; null otherwise
Format: date-time
hired_at (anyOf 2)nullAlternativeTimestamp when the application reached the hired stage; null otherwise
Format: date-time
idstringRequired within parentApplication unique identifier
Format: uuid
jobModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item job
Job information for the application
job_employment_typeModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item job employment type
Employment type information for the job
job_postingJSONOptionalJob posting information (if application came through a posting)
job_posting (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS applications — 200 response body — data item job posting id, title
job_posting (anyOf 2)nullAlternative
moved_to_current_stage_atstringRequired within parentTimestamp of when the application moved to current stage
Format: date-time
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeApplication numeric identifier
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source_channel_campaign_slugJSONOptional
source_channel_campaign_slug (anyOf 1)stringAlternativeHiring campaign of the source channel the application came through; null when none
source_channel_campaign_slug (anyOf 2)nullAlternativeHiring campaign of the source channel the application came through; null when none
source_channel_medium_slugJSONOptional
source_channel_medium_slug (anyOf 1)stringAlternativeKind of placement of the source channel the application came through; null when none
source_channel_medium_slug (anyOf 2)nullAlternativeKind of placement of the source channel the application came through; null when none
source_channel_nameJSONOptional
source_channel_name (anyOf 1)stringAlternativeWhere the candidate clicked: the source channel of the source channel the application came through; null when none
source_channel_name (anyOf 2)nullAlternativeWhere the candidate clicked: the source channel of the source channel the application came through; null when none
source_slugJSONOptional
source_slug (anyOf 1)stringAlternativeSource of the application
source_slug (anyOf 2)nullAlternativeSource of the application
stage_historyarrayOptionalChronological stage timeline of the application. Present only when include=STAGE_HISTORY is requested.
stage_history[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item stage history item
submitter_ip_addressJSONOptional
submitter_ip_address (anyOf 1)stringAlternativeIP address of the applicant who submitted the application
submitter_ip_address (anyOf 2)nullAlternativeIP address of the applicant who submitted the application
submitter_user_agentJSONOptional
submitter_user_agent (anyOf 1)stringAlternativeUser agent of the applicant who submitted the application
submitter_user_agent (anyOf 2)nullAlternativeUser agent of the applicant who submitted the application
updated_atstringOptionalTimestamp of when the application was last updated
Format: date-time

Referenced models: Retrieve a list of ATS applications — 200 response body — data item job, Retrieve a list of ATS applications — 200 response body — data item job employment type, Retrieve a list of ATS applications — 200 response body — data item job posting id, title, Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id, Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item, Retrieve a list of ATS applications — 200 response body — data item candidate, Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage, Retrieve a list of ATS applications — 200 response body — data item stage history item

Retrieve a list of ATS applications — 200 response body — data item job
FieldTypePresenceDescription and constraints
$objectRootJob information for the application
idstringRequired within parentJob unique identifier
Format: uuid
titlestringRequired within parentJob title
Retrieve a list of ATS applications — 200 response body — data item job employment type
FieldTypePresenceDescription and constraints
$objectRootEmployment type information for the job
employment_typeModelRequired within parentExpand Retrieve a list of ATS applications — 200 response body — data item job employment type employment type
idstringRequired within parentJob employment type unique identifier
Format: uuid

Referenced models: Retrieve a list of ATS applications — 200 response body — data item job employment type employment type

SDK function policy ID: deel.atsapplications_retrievealistofatsapplications_v2026_01_01. Catalog operation: atsapplications_retrievealistofatsapplications_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.