Integrations Enabling the API

Access Roles

Each access key is granted one or more of nine permissions — grant only what an integration actually needs, since every key can be scoped independently.

Published 2026/08/26

Every access key is granted one or more of the following permissions. An endpoint returns 403 Forbidden if the key used doesn't have the permission it needs — see Errors.

PermissionUnlocks
List tasksListing, fetching, and searching Tasks
Update tasksUpdating a Task (beta)
List testsListing, fetching, and searching Tests
List usersListing, fetching, and searching Users
Write usersReserved — no user-creation or user-update endpoint is available yet
List ticketsListing, fetching, and searching Candidates, and listing/fetching/searching Test Sessions & Results
Write ticketsCreating, updating, and deleting Candidates
Query test resultsReading a Test Session's result and score breakdown
Fetch monitoring assetsFetching Proctoring Evidences and Answers of a Test Session

“Ticket” here is the internal name for what the REST API calls a Candidate — the permission names haven't caught up to the current terminology, but List tickets / Write tickets are exactly the permissions that gate the Candidates endpoints.

Go back