List candidates
Candidates of your agency or of one Talent Pool, with title, company and owner.
GET https://cotlet.dev/api/v1/vincere/candidates
read
Lists candidates as the Candidates table shows them, one page at a time; pass next_cursor back as cursor for the next page. talent_pool takes the name of a Talent Pool. query matches the candidate name. Use candidate_id from here in get_candidate, shortlist_candidates and add_comment.
Parameters
| Name | Type | Description |
|---|---|---|
| talent_pool string | string | Name of a Talent Pool to list. |
| query string | string | Part of the candidate name. |
| limit integer | integer | How many candidates to return on one page. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/vincere/candidates \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("vincere", "list_candidates")const result = await cotlet.call('vincere', 'list_candidates');cotlet call vincere list_candidatesExample response
{
"candidates": [
{
"candidate_id": "88214",
"name": "Priya Nair",
"job_title": "Java Developer",
"current_company": "Northwind Systems",
"owner": "Dana Fox"
},
{
"candidate_id": "88230",
"name": "Tomas Wu",
"job_title": "Project Manager",
"current_company": "Harbor Labs",
"owner": "Dana Fox"
}
],
"next_cursor": null
}