Retrieve an opportunity

Required scopes: opportunities:read

Read-only. The opportunity is the candidate/interview-cycle work view for an application; candidate creation and application-owned writes happen through People plus Applications.

Example (curl):

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

Example (TypeScript):

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

get/v1/opportunities/{opportunity_id}

Request

Base URL: https://api.yardstick.team
URL: https://api.yardstick.team/v1/opportunities/{opportunity_id}
Auth: HTTP bearer

Path parameters

opportunity_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

idstring required

Display id, e.g. opp_<base32>

object'opportunity' required

livemodeboolean required

dashboard_urlstring nullable required

Changes

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