Search candidates
Candidates by name or email, with their applications and current stage.
GET https://cotlet.dev/api/v1/ashby/candidates/search
read
Finds candidates whose name or email matches the query and returns each with the jobs they applied to and the stage of every application. Use candidate_id in get_candidate and send_email, and application_id in the write tools.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Name or email, or part of it. |
| tag string | string | Only candidates with this tag from Add tags. |
Request
curl "https://cotlet.dev/api/v1/ashby/candidates/search?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("ashby", "search_candidates", {"query":"query"})const result = await cotlet.call('ashby', 'search_candidates', {"query":"query"});cotlet call ashby search_candidates --data '{"query":"query"}'Example response
{
"candidates": [
{
"candidate_id": "e1f7a309-4c52-4d8b-a063-9b25d7c1e840",
"name": "Ana Costa",
"email": "ana.costa@example.com",
"applications": [
{
"application_id": "9c41b7a2-6e03-4d58-a1f9-3b8d25e07c64",
"job": "Product Designer",
"stage": "Offer",
"status": "Active"
}
]
}
]
}