Get candidate

One candidate record with contact fields, location, skills and work history.

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

read

Returns the name, contact fields, location, skills and work history shown on the record. Notes are not included; list_candidate_notes reads them. A record you cannot open in JobDiva answers APP_PERMISSION_DENIED.

Parameters

Parameters: get_candidate
NameTypeDescription
candidate_id integer required integer Candidate ID from search_candidates or find_candidate.

Request

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

Example response

JSON

{
  "candidate_id": 5821904,
  "name": "Priya Raman",
  "email": "priya.raman@example.com",
  "phone": "+1 312 555 0147",
  "location": "Chicago, IL",
  "skills": [
    "SQL",
    "dbt",
    "Looker"
  ],
  "experience": [
    {
      "title": "Data Analyst",
      "company": "Brightpath Retail",
      "from": "2020-03",
      "to": null
    }
  ]
}

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.