Skip to main content
GET

Query Parameters

string
Filter the result by candidate type. One of: applicant prospect upload. If omitted, all three types are returned.

Authentication

string
required
Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Response

boolean
Indicates if the request was successful
integer
Total number of candidates returned
array
Array of candidate objects

Error Responses

400 Bad Request

401 Unauthorized