Skip to content
GET /unified/ats/candidates

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

job_idstring
9 supported2 required9 notes
Breezy
required

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

Sage HR
required

The ID of the job to filter the candidates by.

BambooHR
supported

The ID of the job to filter the candidates by.

Greenhouse
supported

The ID of the job to filter the candidates by.

Homerun
supported

The ID of the job to filter the candidates by.

JazzHR
supported

The ID of the job to filter the candidates by.

Lever
supported

The ID of the job to filter the candidates by.

Recruitee
supported

The ID of the job to filter the candidates by.

SmartRecruiters
supported

The ID of the job to filter the candidates by.

organization_idstring

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

1 supported
Breezy
supported
sort_byobject
Possible values:
created_atupdated_at
2 supported
Breezy
supported
Loxo
supported
created_atstring · date-time

The date and time of the phone number's creation

Possible values:
ascdesc
1 supported
Breezy
supported
updated_atstring · date-time

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

Possible values:
ascdesc
1 supported
Breezy
supported
jobobject

The job interview stage's job

2 supported
Fountain
supported
Workable
supported
idstring

Unique identifier of the job

current_stage
1 supported
Fountain
supported
created_atstring · date-time

The date and time of the phone number's creation

22 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
CATS
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
updated_atstring · date-time

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

17 supported
Breezy
supported
CATS
supported
Fountain
supported
Greenhouse
supported
HR Cloud
supported
JobScore
supported
Jobvite
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
tagsobject[]

The candidate's tags

16 supported
Ashby
supported
Breezy
supported
CATS
supported
Fountain
supported
Greenhouse
supported
JobScore
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Zoho Recruit
supported
idstring

The tag's unique identifier

namestring

The tag's name

emailsstring

The email of the candidate to filter the candidates by.

24 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
emailstring

The candidate's email

typestring

The candidate's email type

idsstring[]

The ID of the candidate to filter the candidates by.

1 supported
Greenhouse
supported
namestring

The user's full name

23 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Workable
supported
Zoho Recruit
supported
titlestring

The candidate's title

11 supported
ApplicantStack
supported
Breezy
supported
CATS
supported
Ceipal
supported
Greenhouse
supported
Jobvite
supported
Loxo
supported
Recruiterflow
supported
SmartRecruiters
supported
TalentLyft
supported
Zoho Recruit
supported
companystring

The candidate's company

9 supported
CATS
supported
Greenhouse
supported
Jobvite
supported
Lever
supported
Loxo
supported
Recruiterflow
supported
TalentLyft
supported
Workable
supported
Zoho Recruit
supported
stage_idstring

The ID of the stage to filter the candidates by.

1 supported
Workable
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

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_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Response Body

next_cursorstring

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.

resultobject[]

List of Candidates

idstring
required·

The candidate's unique identifier

25 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
applicationsobject[]

The candidate's applications

21 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
12 properties
applied_atstring · date-time

The date and time of the application's creation

attachmentsobject[]

The application's attachments

9 properties
idstring
required·

The attachment's unique identifier

applicationobject

The attachment's application

1 property
idstring

Unique identifier of the application

attachment_typestring

The attachment's type

candidateobject

The attachment's candidate

1 property
idstring

Unique identifier of the candidate

created_atstring · date-time

The date and time of the attachment's creation

file_namestring

The attachment's file_name

file_urlstring

The attachment's file_url

jobobject

The attachment's job

1 property
idstring

Unique identifier of the job

updated_atstring · date-time

The date and time of the attachment's last update

candidateobject

The application's candidate

1 property
idstring

Unique identifier of the candidate

created_atstring · date-time

The date and time of the application's creation

credited_toobject

The application's credited_to

4 properties
emailsobject[]
3 properties
emailstring

Email of the user

is_primaryboolean

Whether the email is primary

typestring

Type of the email

first_namestring

First name of the user

idstring

Unique identifier of the user

last_namestring

Last name of the user

current_stageobject

The application's current_stage

5 properties
created_atstring · date-time

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

idstring

The application's current_stage's unique identifier

jobobject

The application's current_stage's job

1 property
idstring

Unique identifier of the job

namestring

The application's current_stage's name

updated_atstring · date-time

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

idstring

The application's unique identifier

jobobject

The application's job

1 property
idstring

Unique identifier of the job

reject_reasonstring

The application's reject_reason

rejected_atstring · date-time

The date and time of the application's rejection

sourceobject

The application's source

2 properties
idstring

The application's source's unique identifier

namestring

The application's source's name

updated_atstring · date-time

The date and time of the application's last update

attachmentsobject[]

The candidate's attachments

9 supported
Ashby
supported
Breezy
supported
CATS
supported
Greenhouse
supported
HR Cloud
supported
Jobvite
supported
Pinpoint
supported
Recruiterflow
supported
Teamtailor
supported
9 properties
idstring
required·

The attachment's unique identifier

applicationobject

The attachment's application

1 property
idstring

Unique identifier of the application

attachment_typestring

The attachment's type

candidateobject

The attachment's candidate

1 property
idstring

Unique identifier of the candidate

created_atstring · date-time

The date and time of the attachment's creation

file_namestring

The attachment's file_name

file_urlstring

The attachment's file_url

jobobject

The attachment's job

1 property
idstring

Unique identifier of the job

updated_atstring · date-time

The date and time of the attachment's last update

can_emailboolean

Whether the candidate can email

8 supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Recruiterflow
supported
TalentLyft
supported
Teamtailor
supported
Zoho Recruit
supported
companystring

The candidate's company

9 supported
CATS
supported
Greenhouse
supported
Jobvite
supported
Lever
supported
Loxo
supported
Recruiterflow
supported
TalentLyft
supported
Workable
supported
Zoho Recruit
supported
created_atstring · date-time

The date and time of the phone number's creation

22 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
CATS
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
emailsobject[]

The candidate's emails

24 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
2 properties
emailstring

The candidate's email

typestring

The candidate's email type

first_namestring

The candidate's first_name

21 supported
ApplicantStack
supported
BambooHR
supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Pinpoint
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
is_privatestring

Whether the candidate is_private

4 supported
Greenhouse
supported
Lever
supported
SmartRecruiters
supported
Teamtailor
supported
last_interaction_atstring · date-time

The candidate's last_interaction date

6 supported
CATS
supported
Greenhouse
supported
Lever
supported
Recruiterflow
supported
TalentLyft
supported
Zoho Recruit
supported
last_namestring

The candidate's last_name

21 supported
ApplicantStack
supported
BambooHR
supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Pinpoint
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
locationsstring[]

The candidate's locations

16 supported
ApplicantStack
supported
Breezy
supported
CATS
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Recruiterflow
supported
SmartRecruiters
supported
TalentLyft
supported
Workable
supported
Zoho Recruit
supported
namestring

The user's full name

23 supported
ApplicantStack
supported
Ashby
supported
BambooHR
supported
Breezy
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Workable
supported
Zoho Recruit
supported
phonesobject[]

The candidate's phone numbers

23 supported
ApplicantStack
supported
Ashby
supported
Breezy
supported
CATS
supported
Ceipal
supported
Fountain
supported
Greenhouse
supported
Homerun
supported
HR Cloud
supported
JazzHR
supported
JobScore
supported
Jobvite
supported
Keka
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
3 properties
extensionstring

The extension of the phone number

numberstring

The candidate's phone number

typestring

The candidate's phone number type

remote_dataRecord<string, any>

Raw data returned from the remote API call.

tagsobject[]

The candidate's tags

16 supported
Ashby
supported
Breezy
supported
CATS
supported
Fountain
supported
Greenhouse
supported
JobScore
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
Sage HR
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Zoho Recruit
supported
2 properties
idstring

The tag's unique identifier

namestring

The tag's name

titlestring

The candidate's title

11 supported
ApplicantStack
supported
Breezy
supported
CATS
supported
Ceipal
supported
Greenhouse
supported
Jobvite
supported
Loxo
supported
Recruiterflow
supported
SmartRecruiters
supported
TalentLyft
supported
Zoho Recruit
supported
updated_atstring · date-time

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

17 supported
Breezy
supported
CATS
supported
Fountain
supported
Greenhouse
supported
HR Cloud
supported
JobScore
supported
Jobvite
supported
Lever
supported
Loxo
supported
Pinpoint
supported
Recruitee
supported
Recruiterflow
supported
SmartRecruiters
supported
TalentLyft
supported
Teamtailor
supported
Workable
supported
Zoho Recruit
supported
urlsobject[]

The candidate's urls

10 supported
Ashby
supported
CATS
supported
Greenhouse
supported
HR Cloud
supported
JobScore
supported
Lever
supported
Recruiterflow
supported
TalentLyft
supported
Teamtailor
supported
Zoho Recruit
supported
2 properties
typestring

The candidate's URL type

urlstring

The candidate's URL

curl -X GET 'https://api.truto.one/unified/ats/candidates?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/ats/candidates?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/ats/candidates"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'ats',
  'candidates',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "ats",
        "candidates",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())