Skip to content
rigid.fi

List screening candidates

GET/v1/candidates

Requires an API client bearer token.

Lists candidates from each subject's most recent screening (tenant-scoped), optionally filtered by status, with dispositions applied live. This is the pending-review queue when filtered to `status=pending`. Cursor-paginated on id.

Parameters

Query parameters

NameRequiredDescription
statusoptional
limitoptional
starting_afteroptional

Example

curl https://api.rigid.fi/v1/candidates \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

A list of candidates.

candidatesarray of objectrequired
+ show properties
idstringrequired
subject_idstringrequired
screening_idstringrequired
entry_hashstringrequired
sourcestringrequired
source_refstringrequired
primary_namestringrequired
scorenumberrequired
status"pending" | "suppressed" | "confirmed"required
awaiting_confirmationobject
+ show properties
reviewer_namestringrequired
recorded_atstringrequired
created_atstringrequired
has_morebooleanrequired
next_cursorstring (uuid) | nullrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring