Scheduling

Check interview session scheduling readiness

Check interview session scheduling readiness

Required scopes: scheduling:read

Read-only. Returns { ready: true } when the session is schedulable, or a blocker envelope ({ ready: false, blocker_code, blocker_message, blocker_metadata }) identifying the recovery flow. Stable blocker codes cover interviewer assignment, provider setup, event-type mapping, and plan-lineage resolution: INTERVIEWER_ASSIGNMENT_REQUIRED, INTERVIEWER_ASSIGNMENT_AMBIGUOUS, SCHEDULER_INTEGRATION_REQUIRED, SCHEDULER_WEBHOOK_SETUP_REQUIRED, SCHEDULER_EVENT_TYPE_MAPPING_MISSING, INTERVIEW_PLAN_NOT_FOUND, INTERVIEW_PLAN_AMBIGUOUS, INTERVIEW_PLAN_LINEAGE_MISMATCH. When the mapping blocker fires, metadata may include the interview duration, mapping key, provider, integration id, assigned scheduler ids, and settings_url for /admin/integrations/scheduling; it does not include provider secrets. Plan-lineage blockers return safe application/job/session context, candidate plan counts, and plan source context without interview sequences or provider internals. Inherits the org-default rate limit applied by withApi; no Idempotency-Key semantics (idempotency keys are ignored on GET).

Example (curl):

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

Example (TypeScript):

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

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/interview_sessions/{interview_session_id}/actions/readiness
  • 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

OR

Changes

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