GET List Candidates
Get candidates
Scopescandidates:read / candidates:write
GET/api/v1/public/:tenant_slug/candidates
| Name | Type | Required | Description |
|---|---|---|---|
| tenant_slug | string | yes | Tenant slug. |
| page | integer | no | Default 1. |
| per_page | integer | no | Default 25. |
| sort | string | no | Example: -updated_at. |
| filter[recruiter_id] | integer | no | Filter by recruiter. |
| filter[q] | string | no | Search by full name. |
Request
curl -H "Authorization: Bearer <API_KEY>" \
"http://localhost:3333/api/v1/public/agado-ats/candidates?filter[q]=Ana"200 Response
{
"data": [{ "id": 504, "full_name": "Ana Novak", "headline": "QA Engineer", "source_id": 22 }],
"meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}400 Response
{
"error": {
"code": "bad_request",
"message": "Validation failed for request payload",
"request_id": "req_123"
}
}401 Response
{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key",
"request_id": "req_401"
}
}403 Response
{
"error": {
"code": "forbidden",
"message": "API key does not have required scope",
"request_id": "req_403"
}
}404 Response
{
"error": {
"code": "not_found",
"message": "Resource was not found",
"request_id": "req_404"
}
}500 Response
{
"error": {
"code": "internal_error",
"message": "Unexpected server error",
"request_id": "req_500"
}
}See Error code catalog.