Invitations

Query parameters

Response fields

data

array of object. This page, newest first.

data[].id

uuid. The invitation's id.

data[].email

string. The address invited.

data[].status

one of open, accepted, declined, expired, withdrawn. Where it stands. An unanswered invitation past its date reads expired.

data[].sponsored

boolean. The organisation pays for the candidate's verification.

data[].position_id

uuid or null. The position it was sent for; null for none.

data[].candidate_id

uuid or null. The grant once accepted: the id for /candidates/{id}.

data[].custom_data

object or null. Your own data on the invitation, as you sent it; null for none.

data[].created_at

string. When it was sent (ISO 8601).

data[].expires_at

string or null. When an unanswered invitation expires (ISO 8601).

next_cursor

string or null. Pass it as cursor for the next page; null on the last.

Errors

• 400 api.credential_in_url
• 401 api.key_invalid
• 401 api.key_expired
• 401 api.key_revoked
• 401 api.key_suspended
• 403 api.scope_missing
• 429 api.rate_limited