Candidates

List candidates

get/recruitment/candidates

Request

Base URL
https://app.peopleforce.io/api/public/v3
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/peopleforce/apis/company-api/docs/recruitment/candidates/get.ts
A function with typed inputs. Its response is checked against the schema.

pipeline_stage_idinteger

Filter candidates by pipeline stage ID

skills[]string

Filter candidates by skills. Multiple skills can be provided using an ampersand separated list

vacancy_ids[]integer

Filter candidates by vacancy IDs. Multiple vacancy ids can be provided using an ampersand separated list

emailstring

Filter candidates by email

created_at[gte]string

Filter candidates created on or after this value.

created_at[lte]string

Filter employees created on or before this value.

updated_at[gte]string

Filter candidates updated on or after this value.

updated_at[lte]string

Filter employees updated on or before this value.

pageinteger

A cursor for pagination across multiple pages of results.

No recorded changes to this operation across all 1 revision of this API.