Opportunities

List opportunities

List opportunities

Required scopes: opportunities:read

Read-only. Opportunities are enriched candidate and interview-cycle work views over applications and related context. Use them for queues, next actions, and dashboard handoff; do not use this resource to create candidates or mutate application state.

Example (curl):

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

Example (TypeScript):

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

Request

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

Query parameters

limitinteger

Page size (1-100, default 20).

starting_afterstring

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

statusstring

Filter by application status.

stagestring

Filter by application stage.

person_idstring

Filter by canonical per_... person id.

application_idstring

Filter by canonical app_... application id.

job_posting_idstring

Filter by existing jp_... posting id.

created[gte]string date-time

ISO-8601 UTC; only opportunities at or after this time.

created[lte]string date-time

ISO-8601 UTC; only opportunities at or before this time.

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.