Skip to main content
GET
Get Candidates

Authorizations

x-api-key
string
header
required

Query Parameters

integrationSource
string

Filter by integration source. Must be provided with externalId.

externalId
string

Filter by external ID from the ATS integration. Must be provided with integrationSource.

page
integer
default:1

Page number (default: 1)

Required range: x >= 1
pageSize
integer
default:100

Number of candidates per page (default: 100, max: 1000)

Required range: 1 <= x <= 1000

Response

Successfully retrieved candidates

candidates
object[]
required

List of candidates for the current page

pagination
object
required

Pagination metadata