Skip to navigation

List colour Candidates

Your candidates, newest first: the review queue. Repeat review_status (pending, accepted, rejected) to narrow the list, or send assessment_id for the candidates one assessment produced. Pages are chained with next_cursor, opaque and bound to this query’s filters and to you: send it back with the same filters, or the answer is 400 INVALID_CURSOR. An unknown or repeated parameter, and a filter value that is not valid, is 400 INVALID_REQUEST naming it. Requires the digitisation.read scope, which your account operator provisions; served only where digitisation is enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Query parameters

limitstring or nullOptional

Page size, an integer 1-100 (default 20).

cursorstring or nullOptional

The previous page’s next_cursor.

review_statuslist of strings or nullOptional

Only candidates in these review states (repeatable): pending, accepted, rejected.

assessment_idstring or nullOptional
Only the candidates measured by this assessment.

Response

A page of the caller's candidates, newest first
datalist of objects
has_moreboolean
next_cursorstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
503
Service Unavailable Error