Results

Calling the /candidates endpoint will return a collection of the job's candidates. If no query parameter is defined, all candidates will be returned.

By default results are limited to 50. The limit can be updated via the request parameter limit. The value specified cannot be more than 100 per page.

key	description
candidates	array of candidates
paging	Includes the `next` URL pointing to the next results page, in case there are more results than the provided limit

Each candidate will have the following keys:

key	type	description
id	`string`	The candidate identifier
name	`string`	Candidate's full name
firstname	`string`	Candidate's first name
lastname	`string`	Candidate's last name
headline	`string`	Candidate's headline
account/subdomain	`string`	Account's subdomain
account/name	`string`	Account's name
job/shortcode	`string`	Job's system generated code
job/title	`string`	Job's title
stage	`string`	Candidate's stage slug
stage_kind	`string`	Candidate's stage kind
disqualified	`boolean`	True if the candidate is disqualified
withdrew	`boolean`	True if the candidate withdrew and was disqualified
disqualification_reason	`string`	null if the member has not provided a disqualification reason
sourced	`boolean`	True if the candidate has been sourced
profile_url	`string`	Candidate's URL in Workable
email	`string`	Candidate's email
domain	`string`	Where candidate come from
created_at	`string`	Timestamp when the candidate was created
updated_at	`string`	Last timestamp when the candidate was updated
hired_at	`date`	The date the candidate was moved to the hired stage
address	`string`	The address of the candidate
phone	`string`	The phone number of the candidate