Opportunities

Resolve an opportunity to a dashboard deep link

Resolve an opportunity to a dashboard deep link

Required scopes: opportunities:read

Returns { id, web_url, route, mode } pointing at the dashboard OpportunityDetailPage for candidate/interview-cycle workflow. Opportunity dashboard URLs use /opportunities/:id; during the current compatibility window, :id may be the opp_… display id exposed by list/read responses or the raw application UUID returned by this deep-link endpoint. Application Review detail links use /jobs/:jobId/review/:applicationId. Mode-partitioned: a live token requesting a test opportunity returns 404 not_found.

Example (curl):

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

Example (TypeScript):

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

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/opportunities/{opportunity_id}/actions/deep_link
  • 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

object required

Changes

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