Get candidate

One candidate with contact details, questionnaire answers, source and notes on the job.

GET https://cotlet.dev/api/v1/jazzhr/candidates/{candidate_id}

read

Returns the profile fields JazzHR holds for one candidate: contact details, source, rating, questionnaire answers and the notes on the chosen job. Notes are job-specific in JazzHR, so a note from another job is not returned. Files and resumes are listed by name only.

Parameters

Parameters: get_candidate
NameTypeDescription
candidate_id string required string Candidate ID from list_candidates.
job_id string string Job whose notes and stage to return, when the candidate applied to several.

Request

cURL
curl https://cotlet.dev/api/v1/jazzhr/candidates/candidate_8c41d2 \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("jazzhr", "get_candidate", {"candidate_id":"candidate_8c41d2"})
Node.js
const result = await cotlet.call('jazzhr', 'get_candidate', {"candidate_id":"candidate_8c41d2"});
CLI
cotlet call jazzhr get_candidate --data '{"candidate_id":"candidate_8c41d2"}'

Example response

JSON

{
  "candidate_id": "prospect_20261019_5e2c",
  "name": "Dana Whitfield",
  "email": "dana.whitfield@example.com",
  "job_id": "job_20261012_8f3a",
  "stage": "New",
  "source": "Careers page",
  "answers": [
    {
      "question": "Years of customer support experience",
      "answer": "5"
    },
    {
      "question": "Are you authorized to work in the US?",
      "answer": "Yes"
    }
  ],
  "notes": [],
  "files": [
    "resume.pdf"
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.