Appearance
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, known languages, and custom field values. Education entries carry startYear, startMonth, endYear and endMonth, where 0 means the CV or record did not give that value. The languages list holds code, name and, when a proficiency has been recorded, level; it is omitted when the candidate has no languages. 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
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "address": { "city": "string", "country": "string", "postcode": "string", "state": "string", "street": "string" }, "alternateEmail": "string", "createdOn": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "desiredSalary": 0, "desiredSalaryCurrency": "string", "desiredSalaryTenure": "string", "doNotContact": true, "educationHistory": [ { "endMonth": 0, "endYear": 0, "grade": "string", "id": "string", "level": "string", "major": "string", "organisation": "string", "startMonth": 0, "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", "languages": [ { "code": "string", "level": "string", "name": "string" } ], "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "noticePeriod": "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
{
}