Get a candidate
Read a candidate profile with answers, ratings, notes and messages.
GET https://cotlet.dev/api/v1/homerun/jobs/{job_id}/candidates/{candidate_id}
read
Returns the contact details, the current stage and the stages passed, the answers to the application form, ratings, notes, tags and the latest messages. A candidate belongs to one job, so the same person applying twice has two IDs.
Parameters
| Name | Type | Description |
|---|---|---|
| job_id string required | string | Job ID from list_jobs. |
| candidate_id string required | string | Candidate ID from list_candidates. |
Request
curl https://cotlet.dev/api/v1/homerun/jobs/job_8c41d2/candidates/candidate_8c41d2 \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("homerun", "get_candidate", {"job_id":"job_8c41d2","candidate_id":"candidate_8c41d2"})const result = await cotlet.call('homerun', 'get_candidate', {"job_id":"job_8c41d2","candidate_id":"candidate_8c41d2"});cotlet call homerun get_candidate --data '{"job_id":"job_8c41d2","candidate_id":"candidate_8c41d2"}'Example response
{
"candidate_id": "ap_K2mP7rS1uW5yA9bC3dE6",
"name": "Priya Raman",
"email": "priya.raman@example.com",
"stage": "Application",
"answers": [
{
"question": "How many years of customer-facing experience do you have?",
"answer": "4"
}
],
"rating": 4,
"notes": [],
"tags": [
"shortlist"
],
"messages": []
}