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.
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"]["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 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_alist_of_ats_applications(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | Maximum length: 1000 |
query.limit | integer | Optional | Default: 20 Maximum: 500 Minimum: 1 |
query.search_text | string | Optional | Maximum length: 500 |
query.job_id | string | Optional | Format: uuid |
query.job_ids | array | Optional | |
query.job_ids[] | string | Each item | Format: uuid |
query.hiring_member_hou_ids | array | Optional | |
query.hiring_member_hou_ids[] | string | Each item | Format: uuid |
query.hiring_member_role_ids | array | Optional | |
query.hiring_member_role_ids[] | integer | Each item | |
query.interview_plan_stage_ids | array | Optional | |
query.interview_plan_stage_ids[] | string | Each item | Format: uuid |
query.reached_interview_plan_stage_ids | array | Optional | |
query.reached_interview_plan_stage_ids[] | string | Each item | Format: uuid |
query.moved_to_current_stage_before | string | Optional | Format: date-time |
query.archivation_reason_ids | array | Optional | |
query.archivation_reason_ids[] | string | Each item | Format: uuid |
query.candidate_tag_ids_operator | string | Optional | One of: ANY, ALL |
query.include | array | Optional | |
query.include[] | string | Each item | One of: STAGE_HISTORY |
query.candidate_tag_ids | array | Optional | |
query.candidate_tag_ids[] | string | Each item | Format: uuid |
query.source_slugs | array | Optional | |
query.source_slugs[] | string | Each item | |
query.job_criterias_matchings | array | Optional | |
query.job_criterias_matchings[] | Model | Each item | Expand Retrieve a list of ATS applications — request body — query job criterias matchings item |
query.current_stage_category_type_slugs | array | Optional | |
query.current_stage_category_type_slugs[] | string | Each item | Maximum length: 50 |
query.current_stage_default_type_slugs | array | Optional | |
query.current_stage_default_type_slugs[] | string | Each item | Maximum length: 50 |
query.updated_after | string | Optional | Format: date-time |
query.sort_by | string | Optional | One of: APPLICATION_CREATION_DATE, STAGE_CREATION_DATE |
query.sort_order | string | Optional | One of: ASC, DESC |
Referenced models: Retrieve a list of ATS applications — request body — query job criterias matchings item
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 a list of ATS applications — 200 response body |
Referenced models: Retrieve a list of ATS applications — 200 response body
Schemas
Section titled “Schemas”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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_matched | string | Required within parent | One of: MATCHED, NOT_MATCHED, UNDECIDED |
job_criteria_id | string | Required within parent | Format: uuid |
Retrieve a list of ATS applications — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated list of applications |
data | array | Required within parent | Page of applications |
data[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page; null when there are no more pages |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page; null when there are no more pages |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of applications |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application object |
application_form_form_builder_form_submission_id | JSON | Optional | |
application_form_form_builder_form_submission_id (anyOf 1) | string | Alternative | Application form submission unique identifier Format: uuid |
application_form_form_builder_form_submission_id (anyOf 2) | null | Alternative | Application form submission unique identifier Format: uuid |
application_form_submission | JSON | Optional | Application form submission data with parsed answers |
application_form_submission (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id |
application_form_submission (anyOf 2) | null | Alternative | |
application_job_criterias_matchings | array | Optional | AI-generated job criteria matching results for the application |
application_job_criterias_matchings[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item |
archivation_reason_id | JSON | Optional | |
archivation_reason_id (anyOf 1) | string | Alternative | Reason the application was archived; null unless archived Format: uuid |
archivation_reason_id (anyOf 2) | null | Alternative | Reason the application was archived; null unless archived Format: uuid |
candidate | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item candidate Candidate information associated with the application |
created_at | string | Required within parent | Timestamp of when the application was created Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | User who created the application Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | User who created the application Format: uuid |
current_application_interview_plan_stage | Model | Optional | Expand 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_id | JSON | Optional | |
current_application_interview_plan_stage_id (anyOf 1) | string | Alternative | Current interview plan stage unique identifier Format: uuid |
current_application_interview_plan_stage_id (anyOf 2) | null | Alternative | Current interview plan stage unique identifier Format: uuid |
hired_at | JSON | Optional | |
hired_at (anyOf 1) | string | Alternative | Timestamp when the application reached the hired stage; null otherwise Format: date-time |
hired_at (anyOf 2) | null | Alternative | Timestamp when the application reached the hired stage; null otherwise Format: date-time |
id | string | Required within parent | Application unique identifier Format: uuid |
job | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item job Job information for the application |
job_employment_type | Model | Optional | Expand Retrieve a list of ATS applications — 200 response body — data item job employment type Employment type information for the job |
job_posting | JSON | Optional | Job posting information (if application came through a posting) |
job_posting (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS applications — 200 response body — data item job posting id, title |
job_posting (anyOf 2) | null | Alternative | |
moved_to_current_stage_at | string | Required within parent | Timestamp of when the application moved to current stage Format: date-time |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Application numeric identifier |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
source_channel_campaign_slug | JSON | Optional | |
source_channel_campaign_slug (anyOf 1) | string | Alternative | Hiring campaign of the source channel the application came through; null when none |
source_channel_campaign_slug (anyOf 2) | null | Alternative | Hiring campaign of the source channel the application came through; null when none |
source_channel_medium_slug | JSON | Optional | |
source_channel_medium_slug (anyOf 1) | string | Alternative | Kind of placement of the source channel the application came through; null when none |
source_channel_medium_slug (anyOf 2) | null | Alternative | Kind of placement of the source channel the application came through; null when none |
source_channel_name | JSON | Optional | |
source_channel_name (anyOf 1) | string | Alternative | Where the candidate clicked: the source channel of the source channel the application came through; null when none |
source_channel_name (anyOf 2) | null | Alternative | Where the candidate clicked: the source channel of the source channel the application came through; null when none |
source_slug | JSON | Optional | |
source_slug (anyOf 1) | string | Alternative | Source of the application |
source_slug (anyOf 2) | null | Alternative | Source of the application |
stage_history | array | Optional | Chronological stage timeline of the application. Present only when include=STAGE_HISTORY is requested. |
stage_history[] | Model | Each item | Expand Retrieve a list of ATS applications — 200 response body — data item stage history item |
submitter_ip_address | JSON | Optional | |
submitter_ip_address (anyOf 1) | string | Alternative | IP address of the applicant who submitted the application |
submitter_ip_address (anyOf 2) | null | Alternative | IP address of the applicant who submitted the application |
submitter_user_agent | JSON | Optional | |
submitter_user_agent (anyOf 1) | string | Alternative | User agent of the applicant who submitted the application |
submitter_user_agent (anyOf 2) | null | Alternative | User agent of the applicant who submitted the application |
updated_at | string | Optional | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job information for the application |
id | string | Required within parent | Job unique identifier Format: uuid |
title | string | Required within parent | Job title |
Retrieve a list of ATS applications — 200 response body — data item job employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type information for the job |
employment_type | Model | Required within parent | Expand Retrieve a list of ATS applications — 200 response body — data item job employment type employment type |
id | string | Required within parent | Job employment type unique identifier Format: uuid |
Referenced models: Retrieve a list of ATS applications — 200 response body — data item job employment type employment type
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}