Skip to main content
GET
List all candidates

Authorizations

Authorization
string
header
required

HTTP Basic Authentication with API credentials

Query Parameters

limit
integer
default:20

Maximum number of items to return per page

Required range: 1 <= x <= 100
since
integer

Return items created or modified since this ID

Required range: x >= 0
first_name
string

Search candidates by first name.

last_name
string

Search candidates by last name.

email
string<email>

Search candidates by email address. Searches both primary email and secondary email.

pool_name
string

Search candidates by pool (vivier) name. Can be specified multiple times for AND logic (candidate must be in all specified pools). Use the pipe character | within a single value for OR logic (e.g. pool_name=ios|android).

Response

Paginated list of candidates

_self
string<uri>
_schema
string<uri>
_status
enum<string>
Available options:
OK,
INVALID
_next
string<uri> | null
items
object[]