Scheduling

Retrieve an interview session

Retrieve an interview session

Required scopes: interview_sessions:read

Read-only. Returns a redacted session envelope scoped by application org and mode. interview_version_id is a public iv_... display id when present, and scorecard criteria come from the session-bound version.

Example (curl):

curl https://api.yardstick.team/v1/interview_sessions/is_abc123 \
  -H 'Authorization: Bearer ys_sk_live_…'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/interview_sessions/is_abc123", {
  headers: { Authorization: `Bearer ${process.env.YS_API_KEY}` },
}).then((r) => r.json());
get/v1/interview_sessions/{interview_session_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/interview_sessions/{interview_session_id}
  • Auth: HTTP bearer

Path parameters

interview_session_idstring required

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

object'interview_session' required
idstring required

Display id, e.g. is_<base32>.

application_idstring required

Display id, e.g. app_<base32>.

interview_plan_idstring nullable required

Display id of the bound interview plan, e.g. ipd_<base32>.

statusstring nullable required
booking_statusstring nullable required
scheduled_atstring nullable required

ISO-8601 UTC

scheduled_end_atstring nullable required

ISO-8601 UTC

scheduled_timezonestring nullable required

IANA timezone that preserves the scheduled wall-time intent, or null when the source did not provide an authoritative zone.

started_atstring nullable required

ISO-8601 UTC

completed_atstring nullable required

ISO-8601 UTC

meeting_linkstring nullable required
meeting_locationstring nullable required
interview_version_idstring nullable required

Display id of the assigned interview version, e.g. iv_<base32>.

livemodeboolean required
created_atstring required

ISO-8601 UTC

updated_atstring required

ISO-8601 UTC

Changes

No recorded changes to this operation across all 1 revision of this API.