Candidates

Manage your candidate pool: create, view and track profiles.

Required scope: candidates:read for reading, candidates:write for creating and updating.

List candidates

GET/api/v1/candidates

Returns the paginated list of candidates in the organization.

Query Parameters

Paramètre	Type	Requis	Description
`page`	integer	Non	Page number (default: 1).
`pageSize`	integer	Non	Results per page, max 100 (default: 20).
`search`	string	Non	Search by name or email.
`jobId`	string	Non	Filter by job posting.
`tags`	string	Non	Filter by tag (comma-separated values).

Request

200 Response

GET/api/v1/candidates/:id

Returns the full profile of a candidate.

Path Parameters

Paramètre	Type	Requis	Description
`id`	string	Oui	Unique candidate identifier.

Request

200 Response

POST/api/v1/candidates

Creates a new candidate in your organization.

Body Parameters

Paramètre	Type	Requis	Description
`email`	string	Oui	Unique email (used for invitations).
`firstName`	string	Non	Candidate's first name.
`lastName`	string	Non	Last name.
`phone`	string	Non	Phone number.
`locale`	string	Non	Candidate's preferred language (default: fr).
`cvUrl`	string	Non	URL of the candidate's resume.
`tags`	string[]	Non	Tags attached to the profile within your organization.
`source`	string	Non	Acquisition source (e.g. LinkedIn, Indeed, Referral).

Request

201 Response