---
title: "List opportunities"
method: GET
path: "/v1/opportunities"
tags: ["Opportunities"]
---

# List opportunities

`GET /v1/opportunities`

## Request

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

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

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

**Example (TypeScript):**

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

## Query parameters

- `limit` integer
- `starting_after` string
- `status` string
- `stage` string
- `person_id` string
- `application_id` string
- `job_posting_id` string
- `created[gte]` string, date-time
- `created[lte]` string, date-time

## Headers

- `X-Request-Id` string

## Response `200`

Success

- object: Cursor-paginated list envelope.
  - `object` 'list', required
  - `data` Opportunity[], required
    - `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
  - `has_more` boolean, 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)