---
title: "Retrieve an opportunity"
method: GET
path: "/v1/opportunities/{opportunity_id}"
tags: ["Opportunities"]
---

# Retrieve an opportunity

`GET /v1/opportunities/{opportunity_id}`

## Request

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

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):**

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

**Example (TypeScript):**

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

## Path parameters

- `opportunity_id` string, required

## Headers

- `X-Request-Id` string

## Response `200`

Success

- Opportunity: Read-only opportunity view over an application and its related person, plan, and posting metadata. These views appear in the Yardstick app as Candidates.
  - `id` string, required: Display id, e.g. `opp_<base32>`
  - `object` 'opportunity', required
  - `livemode` boolean, required
  - `dashboard_url` string, nullable, required
  - `application` object, required
    - `id` string, required: Canonical `app_...` application id.
    - `status` string, required
    - `stage` string, required
    - `created` string, nullable, required
    - `updated` string, nullable, required
  - `person` object, nullable, required
    - `id` string, required: Canonical `per_...` person id.
    - `name` string, nullable, required
    - `email` string, nullable, required
  - `interview_plan` object, nullable, required
    - `id` string, required
    - `title` string, nullable, required
    - `role_name` string, nullable, required
  - `job_posting` object, nullable, required
    - `id` string, required
    - `title` string, nullable, required
    - `slug` string, nullable, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failure
- `403`: Permission denied (scope or feature flag)
- `404`: Resource not found. The error uses the resource-specific code and param names the exact body field or path parameter that referenced it.
- `409`: Conflict (e.g. idempotency key reuse with different body)
- `429`: Rate limited
- `500`: Internal error

---

[API](https://skmtc.dev/yardstick/apis/yardstick-public-api.md) · [All operations](https://skmtc.dev/yardstick/apis/yardstick-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yardstick/apis/yardstick-public-api/revisions/bef1d2eaaaa1?raw)