Retrieve an interview plan

Required scopes: interview_plans:read

Read-only. Returns the published or draft plan shape visible to the caller. Published plans are org-scoped role templates: live- and test-mode tokens in the same organization may read them. Draft reads remain livemode-partitioned. Round scorecard criteria are included only from inline round data; the API does not join through interview_versions for plan reads. For a draft's complete builder state (all stage checkpoints, stage_versions, question ids), use GET /v1/interview_plan_drafts/{draft_id} instead.

Example (curl):

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

Example (TypeScript):

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

get/v1/interview_plans/{interview_plan_id}

Request

Base URL: https://api.yardstick.team
URL: https://api.yardstick.team/v1/interview_plans/{interview_plan_id}
Auth: HTTP bearer

Path parameters

interview_plan_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_plan' required

idstring required

lifecycle'published' | 'draft' required

titlestring required

role_namestring nullable required

is_archivedboolean required

draft_status'draft' | 'validated' | 'published' | 'abandoned' nullable required

job_idstring nullable required

versioninteger nullable required

behavioral_anchorsobject required

created_atstring required

updated_atstring required

Changes

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