Get ATS Candidate

get

https://apiv2.{domain}.ai/api/v2/core/ats-systems/{systemId}/ats-candidates/{atsCandidateId}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

atsCandidateId

string

required

ATS entity ID of candidate

systemId

string

required

ATS system id of candidate

Query Params

include

string

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

exclude

string

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.

keyList

string

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

Authorization

string

required

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

Response

Language

URL

Loading…

Response

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

application/json

200OK