Interview Plan Builder

Retrieve a draft's full content

Retrieve a draft's full content

Required scopes: interview_plans:read

Read-only. Returns the draft's complete builder state: every stage checkpoint verbatim (outcomes, competencies, job_skills, interview_sequence, questions_and_directions), the per-stage stage_versions map, draft status, and a source_metadata provenance summary. This is the read half of the fetch-modify-submit editing loop: read the draft, take the edited stage's version from stage_versions, and pass it as the edit action's source_stage precondition. Questions always carry a discoverable id — stored ids verbatim, or a derived question_N fallback for generated questions that have not been edited yet.

Use GET /v1/interview_plans/{interview_plan_id} for the narrow lifecycle-agnostic plan read; use this route when you need full draft content for editing or diffing. Cross-organization, wrong-mode, and unknown draft ids return safe not-found responses.

Example (curl):

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

Example (TypeScript):

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

Request

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

Path parameters

draft_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_draft' required
idstring required
status'draft' | 'validated' | 'published' | 'abandoned' required
job_idstring nullable required
role_contextobject required
questions_and_directionsobject required
stage_versionsobject required
source_metadataobject required
created_atstring required
updated_atstring required

Changes

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