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.
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["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 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.list_interviews(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.interviewer_hou_ids | array | Optional | |
query.interviewer_hou_ids[] | string | Each item | Format: uuid |
query.job_ids | array | Optional | |
query.job_ids[] | string | Each item | Format: uuid |
query.status | array | Optional | |
query.status[] | string | Each item | One of: SCHEDULE_NEEDED, LINK_SENT, SLOT_REQUEST_SENT, SLOTS_SUBMITTED, SCHEDULED, RESCHEDULE_REQUESTED, CANCELLED, COMPLETED |
query.candidate_ids | array | Optional | |
query.candidate_ids[] | string | Each item | Format: uuid |
query.application_ids | array | Optional | |
query.application_ids[] | string | Each item | Format: uuid |
query.interview_plan_stage_ids | array | Optional | |
query.interview_plan_stage_ids[] | string | Each item | Format: uuid |
query.date_range_start | string | Optional | Format: date-time |
query.date_range_end | string | Optional | Format: date-time |
query.updated_after | string | Optional | Format: date-time |
query.sort_order | string | Optional | One of: SCHEDULED_FIRST, NEWEST_FIRST, OLDEST_FIRST, LATEST_MEETING_FIRST |
query.cursor | string | Optional | |
query.limit | integer | Optional | Maximum: 100 Minimum: 1 |
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 List interviews across applications — 200 response body |
Referenced models: List interviews across applications — 200 response body
Schemas
Section titled “Schemas”7 more schemas are linked from the tables above, on the schema pages.
List interviews across applications — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of interviews. |
data[] | Model | Each item | Expand List interviews across applications — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current page. |
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 interviews matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application Application linked to this interview. |
application_activity | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application activity Interview activity details including configuration and participants. |
application_activity_id | string | Required within parent | ID of the application activity linked to this interview. Format: uuid |
application_interview_plan_stage_id | JSON | Optional | |
application_interview_plan_stage_id (anyOf 1) | string | Alternative | ID of the application stage record the interview belongs to. Format: uuid |
application_interview_plan_stage_id (anyOf 2) | null | Alternative | ID of the application stage record the interview belongs to. Format: uuid |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | string | Alternative | Free-text cancellation reason; null unless cancelled. |
cancellation_reason (anyOf 2) | null | Alternative | Free-text cancellation reason; null unless cancelled. |
cancellation_reason_id | JSON | Optional | |
cancellation_reason_id (anyOf 1) | string | Alternative | Cancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled. Format: uuid |
cancellation_reason_id (anyOf 2) | null | Alternative | Cancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled. Format: uuid |
cancelled_at | JSON | Optional | |
cancelled_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the interview was cancelled; null unless cancelled. Format: date-time |
cancelled_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the interview was cancelled; null unless cancelled. Format: date-time |
created_at | string | Required within parent | ISO 8601 datetime when the interview record was created. Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user who created the interview. Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user who created the interview. Format: uuid |
ends_at | JSON | Optional | |
ends_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the interview ends. Format: date-time |
ends_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the interview ends. Format: date-time |
has_happened | boolean | Optional | True 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. |
id | string | Required within parent | Unique identifier of the interview. Format: uuid |
interview_plan_stage | JSON | Optional | The interview plan stage the interview belongs to, independent of the candidate's current stage. |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
meeting_url | JSON | Optional | |
meeting_url (anyOf 1) | string | Alternative | Video conferencing URL for the interview. |
meeting_url (anyOf 2) | null | Alternative | Video conferencing URL for the interview. |
starts_at | JSON | Optional | |
starts_at (anyOf 1) | string | Alternative | ISO 8601 datetime when the interview starts. Format: date-time |
starts_at (anyOf 2) | null | Alternative | ISO 8601 datetime when the interview starts. Format: date-time |
status_enum | string | Required within parent | Current status of the interview. Known values: SCHEDULE_NEEDED, LINK_SENT, SLOT_REQUEST_SENT, SLOTS_SUBMITTED, SCHEDULED, RESCHEDULE_REQUESTED, CANCELLED, COMPLETED |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | IANA timezone of the interview. |
timezone (anyOf 2) | null | Alternative | IANA timezone of the interview. |
updated_at | string | Required within parent | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application linked to this interview. |
candidate | Model | Required within parent | Expand List interviews across applications — 200 response body — data item application candidate Candidate being interviewed. |
current_application_interview_plan_stage | JSON | Optional | The stage the candidate is in now, which may differ from the stage the interview belongs to. |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
id | string | Required within parent | Unique identifier of the application. Format: uuid |
job | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Interview activity details including configuration and participants. |
application_activity_participations | array | Optional | List of interviewers participating in this interview. |
application_activity_participations[] | Model | Each item | Expand List interviews across applications — 200 response body — data item application activity application activity participations item |
interview_title | JSON | Optional | |
interview_title (anyOf 1) | string | Alternative | Title of the interview stage. |
interview_title (anyOf 2) | null | Alternative | Title of the interview stage. |
length_in_minutes | JSON | Optional | |
length_in_minutes (anyOf 1) | JSON | Alternative | |
length_in_minutes (anyOf 1) (anyOf 1) | integer | Alternative | Planned interview duration in minutes. |
length_in_minutes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
length_in_minutes (anyOf 2) | null | Alternative | Planned 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job linked to the application. |
id | string | Required within parent | Unique identifier of the job. Format: uuid |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current interview plan stage. |
id | string | Required within parent | Interview plan stage identifier. Format: uuid |
name | string | Required within parent | Customer-defined stage name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}