Skip to content

Deel: List interviews across applications

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

← ATS operations · Get started

Operation deel.ats_listinterviews_v2026_06_03

Provider route: GET /ats/interviews. 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"]["listInterviews"]>[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.listInterviews(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_interviews(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.interviewer_hou_idsarrayOptional
query.interviewer_hou_ids[]stringEach itemFormat: uuid
query.job_idsarrayOptional
query.job_ids[]stringEach itemFormat: uuid
query.statusarrayOptional
query.status[]stringEach itemOne of: SCHEDULE_NEEDED, LINK_SENT, SLOT_REQUEST_SENT, SLOTS_SUBMITTED, SCHEDULED, RESCHEDULE_REQUESTED, CANCELLED, COMPLETED
query.candidate_idsarrayOptional
query.candidate_ids[]stringEach itemFormat: uuid
query.application_idsarrayOptional
query.application_ids[]stringEach itemFormat: uuid
query.interview_plan_stage_idsarrayOptional
query.interview_plan_stage_ids[]stringEach itemFormat: uuid
query.date_range_startstringOptionalFormat: date-time
query.date_range_endstringOptionalFormat: date-time
query.updated_afterstringOptionalFormat: date-time
query.sort_orderstringOptionalOne of: SCHEDULED_FIRST, NEWEST_FIRST, OLDEST_FIRST, LATEST_MEETING_FIRST
query.cursorstringOptional
query.limitintegerOptionalMaximum: 100
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 interviews across applications — 200 response body

Referenced models: List interviews across applications — 200 response body

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

List interviews across applications — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of interviews.
data[]ModelEach itemExpand List interviews across applications — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 interviews matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List interviews across applications — 200 response body — data item

List interviews across applications — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
applicationModelRequired within parentExpand List interviews across applications — 200 response body — data item application
Application linked to this interview.
application_activityModelRequired within parentExpand List interviews across applications — 200 response body — data item application activity
Interview activity details including configuration and participants.
application_activity_idstringRequired within parentID of the application activity linked to this interview.
Format: uuid
application_interview_plan_stage_idJSONOptional
application_interview_plan_stage_id (anyOf 1)stringAlternativeID of the application stage record the interview belongs to.
Format: uuid
application_interview_plan_stage_id (anyOf 2)nullAlternativeID of the application stage record the interview belongs to.
Format: uuid
cancellation_reasonJSONOptional
cancellation_reason (anyOf 1)stringAlternativeFree-text cancellation reason; null unless cancelled.
cancellation_reason (anyOf 2)nullAlternativeFree-text cancellation reason; null unless cancelled.
cancellation_reason_idJSONOptional
cancellation_reason_id (anyOf 1)stringAlternativeCancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled.
Format: uuid
cancellation_reason_id (anyOf 2)nullAlternativeCancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled.
Format: uuid
cancelled_atJSONOptional
cancelled_at (anyOf 1)stringAlternativeISO 8601 datetime when the interview was cancelled; null unless cancelled.
Format: date-time
cancelled_at (anyOf 2)nullAlternativeISO 8601 datetime when the interview was cancelled; null unless cancelled.
Format: date-time
created_atstringRequired within parentISO 8601 datetime when the interview record was created.
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user who created the interview.
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user who created the interview.
Format: uuid
ends_atJSONOptional
ends_at (anyOf 1)stringAlternativeISO 8601 datetime when the interview ends.
Format: date-time
ends_at (anyOf 2)nullAlternativeISO 8601 datetime when the interview ends.
Format: date-time
has_happenedbooleanOptionalTrue when the interview took place: status SCHEDULED or COMPLETED and the meeting end (or start, when no end is recorded) is in the past. False for cancelled interviews and interviews not yet held.
idstringRequired within parentUnique identifier of the interview.
Format: uuid
interview_plan_stageJSONOptionalThe interview plan stage the interview belongs to, independent of the candidate's current stage.
interview_plan_stage (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number
interview_plan_stage (anyOf 2)nullAlternative
meeting_urlJSONOptional
meeting_url (anyOf 1)stringAlternativeVideo conferencing URL for the interview.
meeting_url (anyOf 2)nullAlternativeVideo conferencing URL for the interview.
starts_atJSONOptional
starts_at (anyOf 1)stringAlternativeISO 8601 datetime when the interview starts.
Format: date-time
starts_at (anyOf 2)nullAlternativeISO 8601 datetime when the interview starts.
Format: date-time
status_enumstringRequired within parentCurrent status of the interview.
Known values: SCHEDULE_NEEDED, LINK_SENT, SLOT_REQUEST_SENT, SLOTS_SUBMITTED, SCHEDULED, RESCHEDULE_REQUESTED, CANCELLED, COMPLETED
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeIANA timezone of the interview.
timezone (anyOf 2)nullAlternativeIANA timezone of the interview.
updated_atstringRequired within parentISO 8601 datetime when the interview record was last updated.
Format: date-time

Referenced models: List interviews across applications — 200 response body — data item application, List interviews across applications — 200 response body — data item application activity, List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number

List interviews across applications — 200 response body — data item application
FieldTypePresenceDescription and constraints
$objectRootApplication linked to this interview.
candidateModelRequired within parentExpand List interviews across applications — 200 response body — data item application candidate
Candidate being interviewed.
current_application_interview_plan_stageJSONOptionalThe stage the candidate is in now, which may differ from the stage the interview belongs to.
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage
current_application_interview_plan_stage (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the application.
Format: uuid
jobModelRequired within parentExpand List interviews across applications — 200 response body — data item application job
Job linked to the application.

Referenced models: List interviews across applications — 200 response body — data item application job, List interviews across applications — 200 response body — data item application candidate, List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage

List interviews across applications — 200 response body — data item application activity
FieldTypePresenceDescription and constraints
$objectRootInterview activity details including configuration and participants.
application_activity_participationsarrayOptionalList of interviewers participating in this interview.
application_activity_participations[]ModelEach itemExpand List interviews across applications — 200 response body — data item application activity application activity participations item
interview_titleJSONOptional
interview_title (anyOf 1)stringAlternativeTitle of the interview stage.
interview_title (anyOf 2)nullAlternativeTitle of the interview stage.
length_in_minutesJSONOptional
length_in_minutes (anyOf 1)JSONAlternative
length_in_minutes (anyOf 1) (anyOf 1)integerAlternativePlanned interview duration in minutes.
length_in_minutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
length_in_minutes (anyOf 2)nullAlternativePlanned interview duration in minutes.

Referenced models: List interviews across applications — 200 response body — data item application activity application activity participations item

List interviews across applications — 200 response body — data item application job
FieldTypePresenceDescription and constraints
$objectRootJob linked to the application.
idstringRequired within parentUnique identifier of the job.
Format: uuid
titlestringRequired within parentTitle of the job position.
List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage
FieldTypePresenceDescription and constraints
$objectRootThe current interview plan stage.
idstringRequired within parentInterview plan stage identifier.
Format: uuid
namestringRequired within parentCustomer-defined stage name.

SDK function policy ID: deel.ats_listinterviews_v2026_06_03. Catalog operation: ats_listinterviews_v2026_06_03. 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-06-03"}

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.