Search candidates
Candidates matching a name, email, phone or resume keyword.
GET https://cotlet.dev/api/v1/jobadder/candidates/search
read
Searches the candidates your JobAdder user can see and returns a page of matches with the candidate_id, name, email, phone and current location of each. Pass next_cursor back as cursor for the next page. The agent uses the candidate_id in get_candidate, add_candidate_note and create_task. A query with no match returns an empty list.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Name, email, phone or resume keyword. |
| limit integer | integer | Maximum candidates to return. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl "https://cotlet.dev/api/v1/jobadder/candidates/search?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("jobadder", "search_candidates", {"query":"query"})const result = await cotlet.call('jobadder', 'search_candidates', {"query":"query"});cotlet call jobadder search_candidates --data '{"query":"query"}'Example response
{
"candidates": [
{
"candidate_id": "cand_20931",
"name": "Priya Nair",
"email": "priya.nair@example.com",
"phone": "+61 400 000 111",
"location": "Sydney"
}
],
"next_cursor": null
}