Get a candidate

GET

/api/nova/candidates/{candidateId}

Fetches a single candidate by its ID. The response contains the full candidate record, including contact details, current employer and job title, location, skills, status, source, tags, rating, overview, internal notes, education and employment history, and custom field values. Responds with 404 if no candidate with the given ID exists, 401 for an invalid API key, and 429 when the account's read rate limit is exceeded.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

candidateId*

candidateId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"data": {

  

  

"alternateEmail": "string",

  

  

"createdOn": "string",

  

  

"currentEmployer": "string",

  

  

"customFields": [

  

  

  

{

  

  

  

  

"boolValue": "string",

  

  

  

  

"dateValue": "string",

  

  

  

  

"fieldId": "string",

  

  

  

  

"fieldLabel": "string",

  

  

  

  

"listValue": [

  

  

  

  

  

"string"

  

  

  

  

],

  

  

  

  

"value": "string"

  

  

  

}

  

  

],

  

  

"dateOfBirth": "string",

  

  

"doNotContact": true,

  

  

"educationHistory": [

  

  

  

{

  

  

  

  

"endYear": 0,

  

  

  

  

"grade": "string",

  

  

  

  

"id": "string",

  

  

  

  

"level": "string",

  

  

  

  

"major": "string",

  

  

  

  

"organisation": "string",

  

  

  

  

"startYear": 0

  

  

  

}

  

  

],

  

  

"email": "string",

  

  

"employmentHistory": [

  

  

  

{

  

  

  

  

"companyName": "string",

  

  

  

  

"employmentType": "string",

  

  

  

  

"endDate": "string",

  

  

  

  

"id": "string",

  

  

  

  

"jobTitle": "string",

  

  

  

  

"startDate": "string",

  

  

  

  

"workSummary": "string"

  

  

  

}

  

  

],

  

  

"facebook": "string",

  

  

"firstName": "string",

  

  

"hasCv": true,

  

  

"homePhone": "string",

  

  

"id": "string",

  

  

"inPipeline": true,

  

  

"internalNotes": "string",

  

  

"jobTitle": "string",

  

  

"lastActivityDate": "string",

  

  

"lastName": "string",

  

  

"linkedIn": "string",

  

  

"location": "string",

  

  

"mobile": "string",

  

  

"overview": "string",

  

  

"ownerId": "string",

  

  

"ownerName": "string",

  

  

"placed": true,

  

  

"rating": 0,

  

  

"reference": "string",

  

  

"rightToWork": true,

  

  

"skills": [

  

  

  

"string"

  

  

],

  

  

"sourceId": "string",

  

  

"sourceName": "string",

  

  

"statusId": "string",

  

  

"statusName": "string",

  

  

"tags": [

  

  

  

{

  

  

  

  

"group": "string",

  

  

  

  

"value": "string"

  

  

  

}

  

  

],

  

  

"twitter": "string",

  

  

"updatedOn": "string",

  

  

"workPermit": true,

  

  

"workPhone": "string"

  

},

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

GET

/api/nova/candidates/{candidateId}

Playground

Authorization

privateApiKey

Variables

Key

Value

candidateId*

apiKey*

Samples