GET
/
candidates
curl --request GET \
  --url https://api.apriora.ai/v1/api/candidates \
  --header 'X-API-Key: <api-key>'
[
  {
    "candidateId": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "resumeUrl": "<string>"
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
email
string

The email of the candidate to filter by

​
candidateId
string

The id of the candidate to filter by

​
positionId
string

The id of the position to filter by. Filters on candidates that have been interviewed for this position.

Response

200
application/json
Candidates response
​
candidateId
string

The unique identifier of the candidate

​
email
string

The email of the candidate

​
firstName
string

The first name of the candidate

​
lastName
string

The last name of the candidate

​
resumeUrl
string | null

The public URL of the candidate's resume, if it exists