Assess API · v1
API Key Scopes
Scopes control exactly what a key can access. When creating a key in Assess → API Keys, select one or more scopes. A key with no scopes selected has full access (useful for internal integrations). For ATS or third-party integrations, always use the narrowest scope needed.
| Scope | Description | Endpoints |
|---|---|---|
organisation:read | Read your org profile, team members, and aggregate stats. | GET /org/, GET /org/team/, GET /org/stats/ |
assessments:read | List and retrieve assessments and their attached task lists. | GET /assessments/, GET /assessments/:slug/, GET /assessments/:slug/cases/ |
assessments:write | Create and update assessments. | POST/PATCH /assessments/ |
invitations:read | List and retrieve candidate invitations and their status. | GET /invites/, GET /invites/:token/ |
invitations:write | Create, bulk-create, remind, and cancel invitations. | POST /invites/, POST /invites/:token/remind/, DELETE /invites/:token/ |
candidates:read | View candidate results, scores, and per-task breakdowns. | GET /assessments/:slug/results/, GET /invites/:token/result/ |
cases:read | List and retrieve custom tasks from your organisation's library. | GET /cases/, GET /cases/:id/ |
cases:write | Create, update, and delete custom tasks. | POST /cases/create/, PATCH /cases/:id/, DELETE /cases/:id/ |
pipelines:read | List hiring pipelines, retrieve pipeline detail, and check enrollment status. | GET /pipelines/, GET /pipelines/:slug/, GET /pipelines/enrollments/:id/ |
pipelines:write | Enroll a candidate into a pipeline (triggers stage-one invitation). | POST /pipelines/:slug/enroll/ |
webhooks:read | List registered webhook endpoints. | GET /webhooks/ |
webhooks:write | Register a new webhook and send a test ping to verify the endpoint. | POST /webhooks/create/, POST /webhooks/:id/test/ |