v1
latestOpenAPI 3.1.02026-07-249097.5 KB/search/new/candidates
Calling this endpoint will return a collection of the company's candidates.
get/c/{company_id}/search/new/candidates
Path parameters
company_idinteger required
Company ID. A company subdomain can also be used.
Query parameters
limitinteger
Specifies the number of candidates to retrieve. Maximum limit in one call is 10 000 candidates.
pageinteger
Page number.
filters_jsonstring[]
Array of filters serialized to a JSON string
sort_bystring
Possible values with suffix _asc or _desc: relevance, created_at, candidate_name, candidate_rating, candidate_positive_ratings, candidate_job_title, candidate_stage_name, gdpr_expires_at, gdpr_uncompleted_change_request_created_at, gdpr_uncompleted_removal_request_created_at,
Response
200
Example response
{
"hits": [
{
"last_activity_at": "2021-10-27T15:21:43Z",
"source": "manual",
"gdpr_expires_at": "2022-04-25T15:20:20Z",
"id": 1711504,
"admin_id": 21775,
"rating_visible": true,
"name": "Stephanie Wood",
"photo_thumb_url": "https://recruitee.s3.eu-central-1.amazonaws.com/candidates/1711504/thumb_photo_un1dgnoee824.png",
"phones": [
"123456789"
],
"created_at": "2021-10-27T15:20:20Z",
"gdpr_status": "no_consent",
"initials": "SW",
"company_id": 155616,
"updated_at": "2022-03-25T09:00:33Z",
"emails": [
"stephanie.wood@email.ghostinspector.com"
],
"placements": [
{
"id": 2001897,
"offer": {
"id": 433778,
"kind": "job",
"slug": "backend-developer",
"status": "internal",
"title": "Backend Developer"
},
"overdue_at": "2021-11-03T15:21:43Z",
"overdue_diff": -13460272,
"rating_visible": true,
"stage": {
"id": 2216727,
"name": "Phone interview",
"time_limit": 604800
}
}
]
}
],
"total": 1
}