The candidate object
| Field | Type | Description |
|---|---|---|
id | string | Use it as candidateId when inviting |
name | string | Full name |
email | string | Where invitations are sent; unique within the company |
headline | string or null | What the person does, one line |
externalId | string or null | An id from another system, when one was stored |
createdAt | date-time | When the candidate was created |
Create a candidate
/v1/candidatesScope candidates:write| Body field | Type | Description |
|---|---|---|
name | string, required | 1 to 200 characters |
email | string, required | A valid email address |
headline | string | Up to 120 characters |
externalId | string | Your own id for the person, such as their ATS id, up to 200 characters; find them by it with ?externalId= |
An email that already has a candidate in your company is a 409 with A candidate with this email already exists. Accepts Idempotency-Key (Idempotency).
List candidates
/v1/candidatesScope candidates:readNewest first. Takes limit, cursor and externalId (only the candidates with that id from another system, an exact match). An invalid filter is a 400 with issues.
Get a candidate
/v1/candidates/{id}Scope candidates:readOne candidate of your company. 404 with Candidate not found. for an id outside your company and once the candidate's erasure was requested.
Erase a candidate
/v1/candidates/{id}Scope candidates:deleteFor a data-subject erasure request. Starts deleting the candidate and everything about them in every part of the product: invitations, sessions, transcripts, audio, analyses and reviewer notes. This can't be undone. Answers 202 with the erasure request; its status turns complete once every service confirmed.