List candidates
This endpoint lets you retrieve all candidates for a given job reference.
This endpoint requires candidates_r
or my_candidates_r
scope.
candidate list
GET
https://www.welcomekit.co/api/v1/external/candidates
Query Parameters
Name | Type | Description |
---|---|---|
referrer | string | Filter by referrer |
job_reference* | string | Job reference |
string | ||
origin | string | Filter by origin |
job_stage_id | string | Filter by job stage id |
job_stage_reference | string | Filter by job stage reference |
archived | string | Only returns archived candidates or not |
created_after | string | Only returns candidates created after this date (YYYY-MM-DD) |
updated_after | string | Only returns candidates updated after this date (YYYY-MM-DD) |
per_page | integer | Number of jobs per page |
page | integer | Page offset |
stage | boolean | Returns related job stage (i.e. refused, hire, etc.) |
tags | boolean | Returns related tags |
Request example
Last updated