List candidates
Search candidates by name, tag, source or job, with title, company and tags.
GET https://cotlet.dev/api/v1/recruiterflow/candidates
read
Searches the candidates your user can see, one page at a time. query matches part of a name, so a short term finds more. location matches the text literally, so New York and NY are different values. job_id limits the result to one job. Each candidate shows the jobs they are on, with the current stage in each.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of the candidate name. |
| tag string | string | Exact tag name, e.g. backend-berlin-sourcing. |
| source string | string | Source of the candidate as Recruiterflow shows it. |
| location string | string | Location text, matched literally. |
| job_id string | string | Only candidates on this job. |
| limit integer | integer | 1 to 50. Default: 25. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/recruiterflow/candidates \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("recruiterflow", "list_candidates")const result = await cotlet.call('recruiterflow', 'list_candidates');cotlet call recruiterflow list_candidatesExample response
{
"candidates": [
{
"candidate_id": "772318",
"name": "Dana Whitfield",
"title": "Product Designer",
"company": "Brightline",
"location": "London",
"tags": [
"design-lead"
],
"jobs": [
{
"job_id": "48307",
"title": "Product Designer",
"stage": "Phone Screen"
}
]
}
],
"next_cursor": null
}