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());
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/opportunities
- Auth: HTTP bearer
Query parameters
Page size (1-100, default 20).
Cursor: id of the last record from the previous page.
Filter by application status.
Filter by application stage.
Filter by canonical per_... person id.
Filter by canonical app_... application id.
Filter by existing jp_... posting id.
ISO-8601 UTC; only opportunities at or after this time.
ISO-8601 UTC; only opportunities at or before this time.
Headers
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
Changes
No recorded changes to this operation across all 2 revisions of this API.