v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

ATS Candidate

Get ATS Candidate

Given an ats candidate id of a candidate, it returns the ats candidate object

get/api/v2/core/ats-systems/{systemId}/ats-candidates/{atsCandidateId}

Path parameters

atsCandidateIdstring required

ATS entity ID of candidate

systemIdstring required

ATS system id of candidate

Query parameters

includestring

Include additional fields in the response. Possible values are applications, tags, notes

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

locationCountrystring nullable

location country of candidate

contactConsentstring nullable

Contact consent for candidate. Valid inputs: applied_only, all, country_only

isAnonymizedboolean nullable

is anonymized candidate

skillsstring[] nullable

skills of candidate

locationstring nullable

location of candidate

addressstring nullable

address of candidate

firstNamestring required

first name of candidate

emailsstring nullable required

email of candidate

visaStatusesstring[] nullable

visa statuses of candidate

veteranStatusStrstring nullable

String value for veteran status of the candidate

isInternalboolean nullable

is internal candidate

customInfoobject nullable

custom info of candidate

systemIdstring nullable

system if of candidate

urlsstring[] nullable

urls of candidate

candidateIdstring nullable required

ATS Candidate id

titlestring nullable

title of candidate

displayTagsstring[] nullable

display tags for candidate

tagsstring[] nullable

tags of candidate

veteranStatusboolean nullable

Boolean value for veteran status of the candidate

highestEducationLevelstring nullable

highest education level of candidate

lastActivityTsinteger nullable required

last activity time stamp of candidate

summarystring nullable

summary of candidate

disabilityStatusboolean nullable

disability status

phonesstring nullable

comma separated phone numbers of candidate

racesstring[] nullable

race of candidate

dateOfBirthstring nullable

date of birth of candidate

genderstring nullable

gender of candidate

disabilityStatusStrstring nullable

disability status of an applicant

lastNamestring nullable

last name of candidate