Search candidates

keyword search, for more information see SmartRecruiters Help Center

number of elements to return. max value is 100

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"

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

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

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

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

candidate’s consent status filter; can be used repeatedly

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 assigned to a candidate; can be used repeatedly; case insensitive; e.g. fluent english

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

candidate's onboarding status

candidate's property id (1-N). Filter candidates by selection type application fields. Each propertyId is paired with propertyValueId at the same array index. Both arrays must have equal length (error code FIELDS_CRITERIA_SIZE_VIOLATED if not). Multiple values for the same property are combined with OR, different properties with AND.

candidate's property value id (1-N). Paired with propertyId by array index. Both arrays must have equal length.

candidate's source type (1-N)

candidate's source subtype (1-N)

candidate's source value id (1-N)

screening question category (1-N)

screening question field id (1-N)

screening question field value id (1-N)