Skip to content

Deel: Get interview notes

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

← ATS operations · Get started

Operation deel.ats_getinterviewnotes_v2026_10_27

Provider route: GET /ats/interviews/{interview_id}/notes. 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"]["getInterviewNotes"]>[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.getInterviewNotes(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.get_interview_notes(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.interview_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalMaximum: 100
Minimum: 1
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get interview notes — 200 response body

Referenced models: Get interview notes — 200 response body

Get interview notes — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of interview notes, oldest first.
data[]ModelEach itemExpand Get interview notes — 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 notes for this interview, across all pages.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get interview notes — 200 response body — data item

Get interview notes — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
content_textstringRequired within parentAI-generated note text summarising part of the interview. Condenses what the candidate said and may contain personal data they volunteered.
created_atstringRequired within parentISO 8601 datetime when the note was generated.
Format: date-time
idstringRequired within parentUnique identifier of the interview note.
Format: uuid
titlestringRequired within parentShort AI-generated title of the note. Derived from the interview conversation.
transcription_content_idJSONRequired within parent
transcription_content_id (anyOf 1)stringAlternativeIdentifier of the transcript segment the note was generated from, matching a segment id of the interview transcript; null when the note is not linked to a single segment.
Format: uuid
transcription_content_id (anyOf 2)nullAlternativeIdentifier of the transcript segment the note was generated from, matching a segment id of the interview transcript; null when the note is not linked to a single segment.
Format: uuid
type_slugstringRequired within parentKind of note: SUMMARY (overall summary), KEY_POINT (a highlight) or OUTLINE (an agenda item of the conversation).
Known values: SUMMARY, KEY_POINT, OUTLINE

SDK function policy ID: deel.ats_getinterviewnotes_v2026_10_27. Catalog operation: ats_getinterviewnotes_v2026_10_27. 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-10-27"}

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.