Skip to content

Deel: List interview plan stages of a job with pipeline counts

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

← ATS operations · Get started

Operation deel.ats_listjobinterviewplanstages_v2026_09_18

Provider route: GET /ats/jobs/{job_id}/interview-plan-stages. 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"]["listJobInterviewPlanStages"]>[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.listJobInterviewPlanStages(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.list_job_interview_plan_stages(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
queryobjectOptionalAdditional keys: not allowed
query.includearrayOptional
query.include[]stringEach itemOne of: CURRENT_APPLICATIONS
query.applications_per_stage_limitintegerOptionalDefault: 10
Maximum: 25
Minimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List interview plan stages of a job with pipeline counts — 200 response body

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body

List interview plan stages of a job with pipeline counts — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentStages of the job's interview plan, in pipeline order.
data[]ModelEach itemExpand List interview plan stages of a job with pipeline counts — 200 response body — data item
has_morebooleanRequired within parentAlways false; the list is not paginated.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null; the list is not paginated.
next_cursor (anyOf 2)nullAlternativeAlways null; the list is not paginated.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of stages.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item

List interview plan stages of a job with pipeline counts — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRootAn interview plan stage of the job with pipeline counts.
category_type_slugstringRequired within parentStage category.
Known values: LEAD, ACTIVE, COMPLETED
current_applicationsarrayOptionalMost recently moved applications currently in the stage. Present only when include=CURRENT_APPLICATIONS is requested.
current_applications[]ModelEach itemExpand List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item
current_applications_countJSONRequired within parent
current_applications_count (anyOf 1)JSONAlternative
current_applications_count (anyOf 1) (anyOf 1)integerAlternativeApplications currently in this stage; null when the caller may not see the job's applications.
current_applications_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_applications_count (anyOf 2)nullAlternativeApplications currently in this stage; null when the caller may not see the job's applications.
default_type_slugJSONRequired within parent
default_type_slug (anyOf 1)stringAlternativeSystem stage type (new_lead, application_review, offer, hired, archived); null for custom stages.
default_type_slug (anyOf 2)nullAlternativeSystem stage type (new_lead, application_review, offer, hired, archived); null for custom stages.
idstringRequired within parentInterview plan stage identifier.
Format: uuid
interview_plan_idstringRequired within parentInterview plan the stage belongs to.
Format: uuid
job_idstringRequired within parentJob the interview plan is attached to.
Format: uuid
namestringRequired within parentCustomer-defined stage name.
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in the interview plan; lower comes first.
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reached_applications_countJSONRequired within parent
reached_applications_count (anyOf 1)JSONAlternative
reached_applications_count (anyOf 1) (anyOf 1)integerAlternativeApplications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications.
reached_applications_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reached_applications_count (anyOf 2)nullAlternativeApplications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications.

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item

List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item
FieldTypePresenceDescription and constraints
$objectRootAn application currently in the stage.
candidateModelRequired within parentExpand List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate
The candidate on the application.
created_atstringRequired within parentWhen the application was created.
Format: date-time
idstringRequired within parentApplication identifier.
Format: uuid
moved_to_current_stage_atstringRequired within parentWhen the application entered this 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]+)?$

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate

List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate
FieldTypePresenceDescription and constraints
$objectRootThe candidate on the application.
emailstringRequired within parentCandidate email.
Format: email
first_namestringRequired within parentCandidate first name.
idstringRequired within parentCandidate identifier.
Format: uuid
last_namestringRequired within parentCandidate last name.

SDK function policy ID: deel.ats_listjobinterviewplanstages_v2026_09_18. Catalog operation: ats_listjobinterviewplanstages_v2026_09_18. 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-09-18"}

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.