Reads all Candidates

get https://api.factorialhr.com/api/v2/resources/ats/candidates

Fetches candidates data from Factorial. When using administrator-level API Credentials, all candidates associated with a company will be returned. When using non-admin level API credentials, only candidates that applied to a job for which the user is a hiring manager will be returned.

Query Params

ids[]

array of integers

list of candidate identifiers.

ids[]

emails[]

array of strings

list of candidate emails.

emails[]

team_ids[]

array of integers

list of team identifiers, refers to teams/teams endpoint.

team_ids[]

location_ids[]

array of integers

list of location identifiers, refers to locations/locations endpoint.

location_ids[]

source[]

array of strings

source of the candidate.

source[]

remote

boolean

is the candidate remote?

job_posting_ids[]

array of integers

list of job posting identifiers, refers to ats/job_postings endpoint.

job_posting_ids[]

minimum_average_rating

number

minimum average rating of the candidate.

active

boolean

is the candidate active?

talent_pool

boolean

is the candidate part of talent pool?

archived

boolean

is the candidate archived?

Response

Response body

array of objects

object

integer

required

identifier of the candidate.

company_id

integer

company identifier.

first_name

string

required

name of the candidate.

last_name

string

required

last name of the candidate.

full_name

string

required

full name of the candidate.

string

email of the candidate.

talent_pool

boolean

required

is the candidate part of talent pool?

phone_number

string

phone number of the candidate.

created_at

string

required

creation date of the candidate.

updated_at

string

required

last update of the candidate.

consent_given_at

string

date when the consent was given.

inactive_since

string

date when the candidate became inactive.

ats_job_posting_ids

array of integers

list of job posting identifiers.

ats_job_posting_ids

personal_url

string

personal web resource from the candidate.

consent_expiration_date

string

date when the consent expires.

consent_to_talent_pool

boolean

consent to talent pool.

medium

string

specifies additional details related to the source of the candidate, such as the referrer name for example if the source is referred.

source_id

integer

candidate source identifier, refers to ats/candidate_sources endpoint.

gender

string

gender of the candidate.

female male unanswered other

score

number

score of the candidate.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.factorialhr.com/api/v2/resources/ats/candidates \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK