Unified API Reference
DashboardSignup For Free

List all Candidates

get
https://api.getknit.dev/v1.0/ats.candidate.list

List candidates in a paginated format with details such as id, firstName, lastName, emails, etc.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

For schema of candidate object refer - Candidate Data Model

This API may not return all fields defined in the response schema; for additional details, use the Get Candidate by Id API.

Supported Apps

Apps supported via API

Zoho Recruit (zoho-recruit)
Vincere (vincere)
HiBob ATS (hibob-ats)
BambooHR ATS (bamboohr-ats)
JobAdder (jobadder)
UKG Pro Recruiting (ukgpro-ats)
Lever (lever)
HR Works ATS (hr-works-ats)
iCIMS (icims)
Breezy (breezy)
  • jobId is required field.
JazzHR ATS (jazzhr-ats)
Greenhouse (greenhouse)
Workable (workable)
JobDiva (jobdiva)
SuccessFactors ATS (successfactors-ats)
TeamTailor (teamtailor)
Keka ATS (keka-ats)
Recruitee (recruitee)
Ashby (ashby)
Oracle HCM ATS (oracle-hcm-ats)
Workday ATS (workday-ats)
Pinpoint (pinpoint)
Recruiterflow (recruiterflow)
Recruit CRM ATS (recruit-crm-ats)
Loxo (loxo)
Jobvite (jobvite)
ERPNext ATS (erpnext-ats)
Personio ATS (personio-ats)
Ceipal (ceipal)

Supported Request Fields:

  • pageToken
  • updatedAfter
  • updatedBefore
  • email
  • originData

Supported Response Fields:

  • candidates.info.id
  • candidates.info.firstName
  • candidates.info.lastName
  • candidates.info.phones.type
  • candidates.info.phones.phoneNumber
  • candidates.info.emails.type
  • candidates.info.emails.email
  • candidates.info.title
  • candidates.info.createdAt
  • candidates.info.updatedAt
  • candidates.locations.addressLine1
  • candidates.locations.city
  • candidates.locations.state
  • candidates.locations.country
  • candidates.locations.addressType
  • candidates.skills.name
  • nextPageToken
  • originData
Eploy (eploy)

Supported Request Fields:

  • pageToken
  • originData

Supported Response Fields:

  • candidates[].info.id
  • candidates[].info.firstName
  • candidates[].info.lastName
  • candidates[].info.phones[].type
  • candidates[].info.phones[].phoneNumber
  • candidates[].info.emails[].type
  • candidates[].info.emails[].email
  • candidates[].info.links[]
  • candidates[].info.tags[]
  • candidates[].info.title
  • candidates[].info.company
  • candidates[].info.createdAt
  • candidates[].info.updatedAt
  • candidates[].locations[].addressLine1
  • candidates[].locations[].addressLine2
  • candidates[].locations[].city
  • candidates[].locations[].state
  • candidates[].locations[].country
  • candidates[].locations[].zipCode
  • candidates[].locations[].addressType
  • candidates[].skills[].name
  • candidates[].experiences[].company
  • candidates[].experiences[].jobTitle
  • candidates[].experiences[].currentlyWorking
  • nextPageToken
  • originData - Returned when requested
Stardex (stardex)

Supported Request Fields:

  • pageToken
  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • email
  • jobId
  • originData

Supported Response Fields:

  • candidates[].info.id
  • candidates[].info.firstName
  • candidates[].info.lastName
  • candidates[].info.phones[].type
  • candidates[].info.phones[].phoneNumber
  • candidates[].info.emails[].type
  • candidates[].info.emails[].email
  • candidates[].info.links[]
  • candidates[].info.title
  • candidates[].info.company
  • candidates[].info.createdAt
  • candidates[].info.updatedAt
  • candidates[].info.applications[]
  • candidates[].education[].id
  • candidates[].education[].degree
  • candidates[].education[].institute
  • candidates[].education[].fromDate
  • candidates[].education[].toDate
  • candidates[].education[].description
  • candidates[].education[].currentlyPursuing
  • candidates[].locations[].addressLine1
  • candidates[].experiences[].company
  • candidates[].experiences[].jobTitle
  • candidates[].experiences[].startDate
  • candidates[].experiences[].endDate
  • candidates[].experiences[].currentlyWorking
  • candidates[].experiences[].summary
  • nextPageToken
  • originData - Returned when requested
TrackerRMS (trackerrms)

Supported Request Fields:

  • pageToken
  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • email
  • tag
  • originData

Supported Response Fields:

  • candidates[].info.id
  • candidates[].info.firstName
  • candidates[].info.lastName
  • candidates[].info.phones[].type
  • candidates[].info.phones[].phoneNumber
  • candidates[].info.emails[].type
  • candidates[].info.emails[].email
  • candidates[].info.links[]
  • candidates[].info.tags[]
  • candidates[].info.title
  • candidates[].info.company
  • candidates[].info.createdAt
  • candidates[].info.updatedAt
  • candidates[].locations[].addressLine1
  • candidates[].locations[].addressLine2
  • candidates[].locations[].city
  • candidates[].locations[].state
  • candidates[].locations[].country
  • candidates[].locations[].zipCode
  • candidates[].locations[].addressType
  • nextPageToken
  • originData - Returned when requested

To see the list of supported filters for an app, refer - ATS List Candidates Filter Support Matrix

Query Params
string
boolean
Defaults to false
date-time

Filters candidates who were created after the specified datetime.
The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters candidates who were created before the specified datetime.
The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters candidates who were updated after the specified datetime.
The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters candidates who were updated before the specified datetime.
The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

string

Filters candidates by one or more job IDs. Supports multiple values as a comma-separated list. (e.g., jobId=24,18,25).

string

Filters candidates by their email address. Supports multiple values as a comma-separated list.
Example: email=[email protected],[email protected]

string

Filters candidates by one or more assigned tags. Supports multiple values as a comma-separated list.
Example: tag=Technical,Remote,Urgent-Hire

Responses

Updated about 16 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 16 hours ago

Did this page help you?