Search candidates

get

https://api.smartrecruiters.com/candidates

Only candidates matching all specified criteria and having at least one job application are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

keyword search, for more information see SmartRecruiters Help Center

limit

integer

1 to 100

Defaults to 10

number of elements to return. max value is 100

pageId

string

page identifier of elements to return

The pageId param can be used to fetch multiple page response, in case the number of results is higher than max number of elements to return (specified in the limit parameter). The pageId should not be present when requesting the first page of results. The pageId of the following page is returned either in the nextPageId property, or is available in the HTTP header Link value of relation type next. Example of the Link header:

</candidates?limit=10&pageId=SKYfn51wTboVGco6%2FvIsIC%2FYbyYP%2F4WgqHLArvCRtYhQEMCgvp1Zj0ya0wpjfKIblyGRcbHytMcvCehVazcjQA%3D%3D>; rel="next"

jobId

array of strings

job filter to display candidates who applied for a job [id]; can be used repeatedly;

jobId

location

array of strings

location keyword search which looks up a string in a candidate’s location data; can be used repeatedly; case insensitive; e.g. Krakow

location

averageRating

array of integers

deprecated

average rating filter to display candidates with a specific average rating (integer); can be used repeatedly; e.g. 4

averageRating

status

array of strings

candidate’s status filter in a context of a job; can be used repeatedly

status

consentStatus

array of objects

candidate’s consent status filter; can be used repeatedly

consentStatus

subStatus

string

candidate’s sub-status filter in a context of a job. Works only in a correlation with a set value for the "status" field.

tag

array of strings

tag assigned to a candidate; can be used repeatedly; case insensitive; e.g. fluent english

tag

updatedAfter

date-time

ISO8601-formatted time boundaries for the candidate update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ

onboardingStatus

string

enum

candidate's onboarding status

Allowed:

propertyId

array of strings

Defaults to

candidate's property id (1-N). Currently it is only possible to filter by single-select application fields. Other application field type filtering is not possible.

propertyId

propertyValueId

array of strings

Defaults to

candidate's property value id (1-N)

propertyValueId

sourceType

array of strings

Defaults to

candidate's source type (1-N)

sourceType

sourceSubType

array of strings

Defaults to

candidate's source subtype (1-N)

sourceSubType

sourceValueId

array of strings

Defaults to

candidate's source value id (1-N)

sourceValueId

questionCategory

array of strings

Defaults to

screening question category (1-N)

questionCategory

questionFieldId

array of strings

Defaults to

screening question field id (1-N)

questionFieldId

questionFieldValueId

array of strings

Defaults to

screening question field value id (1-N)

questionFieldValueId

Responses

200Candidates matching search criteria