Appearance

List Candidates ​

Endpoint ​

http
GET /unified/ats/candidates
Integrations supported
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • ApplicantStack
  • BambooHR
  • Breezy
  • CATS
  • Homerun
  • JazzHR
  • Loxo
  • Recruitee
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Workable

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
job
object

The job interview stage's job

Supported in
  • Fountain
  • Workable
id
string

Unique identifier of the job

current_stage
Supported in
  • Fountain
created_at
string · date-time

The date and time of the phone number's creation

Supported in
  • Fountain
  • Greenhouse
  • HR Cloud
  • JazzHR
  • JobScore
  • Lever
  • Recruitee
  • Teamtailor
  • Workable
  • Zoho Recruit
updated_at
string · date-time

The date and time of the phone number's last update

Supported in
  • Fountain
  • Greenhouse
  • HR Cloud
  • Jobvite
  • Lever
  • SmartRecruiters
  • Teamtailor
  • Workable
  • Zoho Recruit
tags
array

The candidate's tags

Supported in
  • Fountain
  • JobScore
  • Lever
  • Recruitee
  • SmartRecruiters
  • Zoho Recruit
job_id
string
Integration specific notes
  • RecruiteeThe ID of the job to filter the candidates by.
  • BreezyThe unique identifier of the job to fetch the candidates for.
  • LeverThe ID of the job to filter the candidates by.
  • GreenhouseThe ID of the job to filter the candidates by.
  • BambooHRThe ID of the job to filter the candidates by.
  • JazzHRThe ID of the job to filter the candidates by.
  • SmartRecruitersThe ID of the job to filter the candidates by.
  • Sage HRThe ID of the job to filter the candidates by.
  • HomerunThe ID of the job to filter the candidates by.
Required in
  • Breezy
  • Sage HR
Supported in
  • BambooHR
  • Greenhouse
  • Homerun
  • JazzHR
  • Lever
  • Recruitee
  • SmartRecruiters
organization_id
string

The unique identifier of the organization to fetch the candidates for.

Supported in
  • Breezy
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • updated_at
Supported in
  • Breezy
  • Loxo
created_at
string · date-time

The date and time of the phone number's creation

All possible enum values:
  • asc
  • desc
Supported in
  • Breezy
updated_at
string · date-time

The date and time of the phone number's last update

All possible enum values:
  • asc
  • desc
Supported in
  • Breezy
emails
string

The email of the candidate to filter the candidates by.

Supported in
  • Greenhouse
  • Workable
ids
array

The ID of the candidate to filter the candidates by.

Supported in
  • Greenhouse
stage_id
string

The ID of the stage to filter the candidates by.

Supported in
  • Workable
name
string

The user's full name

Supported in
  • Loxo
title
string

The candidate's title

Supported in
  • Loxo
company
string

The candidate's company

Supported in
  • Loxo

Response Body ​

result
object[]

List of Candidates

id
string
REQUIRED · 

The candidate's unique identifier

Supported in
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
first_name
string

The candidate's first_name

Supported in
  • ApplicantStack
  • BambooHR
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
last_name
string

The candidate's last_name

Supported in
  • ApplicantStack
  • BambooHR
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
name
string

The user's full name

Supported in
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Workable
  • Zoho Recruit
company
string

The candidate's company

Supported in
  • CATS
  • Greenhouse
  • Jobvite
  • Lever
  • Loxo
  • Recruiterflow
  • TalentLyft
  • Workable
  • Zoho Recruit
title
string

The candidate's title

Supported in
  • ApplicantStack
  • Breezy
  • CATS
  • Ceipal
  • Greenhouse
  • Jobvite
  • Loxo
  • Recruiterflow
  • SmartRecruiters
  • TalentLyft
  • Zoho Recruit
last_interaction_at
string · date-time

The candidate's last_interaction date

Supported in
  • CATS
  • Greenhouse
  • Lever
  • Recruiterflow
  • TalentLyft
  • Zoho Recruit
is_private
string

Whether the candidate is_private

Supported in
  • Greenhouse
  • Lever
  • SmartRecruiters
  • Teamtailor
can_email
boolean

Whether the candidate can email

Supported in
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Recruiterflow
  • TalentLyft
  • Teamtailor
  • Zoho Recruit
locations
string[]

The candidate's locations

Supported in
  • ApplicantStack
  • Breezy
  • CATS
  • Greenhouse
  • Homerun
  • HR Cloud
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Loxo
  • Recruiterflow
  • SmartRecruiters
  • TalentLyft
  • Workable
  • Zoho Recruit
phones
object[]

The candidate's phone numbers

Supported in
  • ApplicantStack
  • Ashby
  • Breezy
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
number
string

The candidate's phone number

extension
string

The extension of the phone number

type
string

The candidate's phone number type

emails
object[]

The candidate's emails

Supported in
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • CATS
  • Ceipal
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JobScore
  • Jobvite
  • Keka
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
email
string

The candidate's email

type
string

The candidate's email type

urls
object[]

The candidate's urls

Supported in
  • Ashby
  • CATS
  • Greenhouse
  • HR Cloud
  • JobScore
  • Lever
  • Recruiterflow
  • TalentLyft
  • Teamtailor
  • Zoho Recruit
url
string

The candidate's URL

type
string

The candidate's URL type

tags
object[]

The candidate's tags

Supported in
  • Ashby
  • Breezy
  • CATS
  • Fountain
  • Greenhouse
  • JobScore
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Zoho Recruit
id
string

The tag's unique identifier

name
string

The tag's name

applications
object[]

The candidate's applications

Supported in
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Jobvite
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
id
string

The application's unique identifier

candidate
object

The application's candidate

id
string

Unique identifier of the candidate

job
object

The application's job

id
string

Unique identifier of the job

applied_at
string · date-time

The date and time of the application's creation

rejected_at
string · date-time

The date and time of the application's rejection

source
object

The application's source

id
string

The application's source's unique identifier

name
string

The application's source's name

credited_to
object

The application's credited_to

id
string

Unique identifier of the user

first_name
string

First name of the user

last_name
string

Last name of the user

emails
object[]
email
string

Email of the user

type
string

Type of the email

is_primary
boolean

Whether the email is primary

current_stage
object

The application's current_stage

id
string

The application's current_stage's unique identifier

name
string

The application's current_stage's name

job
object

The application's current_stage's job

id
string

Unique identifier of the job

created_at
string · date-time

The date and time of the application's current_stage's creation

updated_at
string · date-time

The date and time of the application's current_stage's last update

reject_reason
string

The application's reject_reason

attachments
object[]

The application's attachments

id
string
REQUIRED · 

The attachment's unique identifier

file_name
string

The attachment's file_name

file_url
string

The attachment's file_url

candidate
object

The attachment's candidate

id
string

Unique identifier of the candidate

application
object

The attachment's application

id
string

Unique identifier of the application

job
object

The attachment's job

id
string

Unique identifier of the job

attachment_type
string

The attachment's type

created_at
string · date-time

The date and time of the attachment's creation

updated_at
string · date-time

The date and time of the attachment's last update

created_at
string · date-time

The date and time of the application's creation

updated_at
string · date-time

The date and time of the application's last update

attachments
object[]

The candidate's attachments

Supported in
  • Ashby
  • Breezy
  • CATS
  • Greenhouse
  • HR Cloud
  • Jobvite
  • Recruiterflow
  • Teamtailor
id
string
REQUIRED · 

The attachment's unique identifier

file_name
string

The attachment's file_name

file_url
string

The attachment's file_url

candidate
object

The attachment's candidate

id
string

Unique identifier of the candidate

application
object

The attachment's application

id
string

Unique identifier of the application

job
object

The attachment's job

id
string

Unique identifier of the job

attachment_type
string

The attachment's type

created_at
string · date-time

The date and time of the attachment's creation

updated_at
string · date-time

The date and time of the attachment's last update

created_at
string · date-time

The date and time of the phone number's creation

Supported in
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • CATS
  • Fountain
  • Greenhouse
  • Homerun
  • HR Cloud
  • JazzHR
  • JobScore
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • Sage HR
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
updated_at
string · date-time

The date and time of the phone number's last update

Supported in
  • Breezy
  • CATS
  • Fountain
  • Greenhouse
  • HR Cloud
  • JobScore
  • Jobvite
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • SmartRecruiters
  • TalentLyft
  • Teamtailor
  • Workable
  • Zoho Recruit
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.