Interview Plans

List interview plans

List interview plans

Required scopes: interview_plans:read

Read-only. Returns published interview plans in the token organization, newest first, partitioned by the token live/test mode and filtered to what the caller may see under the department read boundary. Draft plans are not included here: list them with GET /v1/interview_plan_drafts. Pass job_id to return only the plans linked to one Job.

Example (curl):

curl 'https://api.yardstick.team/v1/interview_plans?limit=20' \
  -H 'Authorization: Bearer ys_sk_live_…'

Example (TypeScript):

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

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/interview_plans
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size (1-100, default 20).

starting_afterstring

Cursor: id of the last record from the previous page.

job_idstring

Return only plans linked to this Job, as a job_... display id. A well-formed id that matches nothing returns an empty list; a malformed one returns 400.

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'list' required
has_moreboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.