Get a candidate
GET
/candidates/{candidateId}
Resume access
resume object includes the original filename and an authenticated download link.resumes.download scope.include=resume_download_url to request a direct file URL valid for five minutes. This also requires resumes.download.Treat direct file URLs as temporary secrets. Do not log, persist or publicly share them.
Permissions
candidates.readRequest
Path Params
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.cvviz.com/v1/candidates/?include=' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Success
{
"data": {
"resume": {
"fileName": "Asha_Sharma_Resume.pdf",
"downloadUrl": "https://api.cvviz.com/v1/candidates/501/resume/download"
},
"currentCompany": "Example Company",
"currentJobTitle": "Backend Engineer",
"phoneCountryCode": "91",
"professionalProfiles": {
"linkedin": null,
"github": null
},
"noticePeriod": {
"value": 1,
"unit": "M"
},
"id": 501,
"originalJobId": 901,
"jobContext": null,
"firstName": "Asha",
"lastName": "Sharma",
"email": "asha.sharma@example.com",
"phone": "+919876543210",
"source": "Career page",
"experienceMonths": 48,
"qualifications": [
"Bachelor's degree"
],
"skills": [
"TypeScript",
"Node.js",
"MySQL"
],
"currentLocation": {
"city": "Pune",
"state": "Maharashtra",
"country": "India"
},
"createdAt": "2026-08-20T08:15:00.000Z",
"updatedAt": "2026-08-30T15:20:00.000Z"
}
}