get https://api.recruitee.com/c//search/new/candidates
Calling this endpoint will return a collection of the company's candidates.
filters_json
Candidates search accepts filters in a form of json array.
| Field | Type of filter | Possible values | Example |
|---|---|---|---|
| "all | "query" | Any string | {"field":"all","query":"Smith"} |
| "admin_id" (UI: Added by) | "in", "not_in" | Array of admin user's IDs | {"field":"admin_id","in":[4367]} |
| "admin_id" (UI: Added by) | "has_any", "has_none" | true | {"field":"admin_id","has_any":true} |
| 'assigned_admins_ids' (UI: Followed/Not followed by) | "has_one_of", "has_all_of", "has_none_of" | Array of admin user's IDs | {"field":"assigned_admins_ids","has_one_of":[4256]} |
| 'assigned_admins_ids' (UI: Followed/Not followed by) | "has_any", "has_none" | true | {"field":"assigned_admins_ids","has_any":true} |
| "created_at" (UI: Profile created) | "gte" - Greater-than or equal to, "gt" - Greater-than, "lte" - Less-than or equal to, "lt" - Less-than | Timestamp format | {"field":"created_at","gte":1548975600,"lte":1549061999} |
| "disqualify_reasons" (UI: Disqualify reason is) | "has_one_of", "has_all_of", "has_none_of" | Array of disqualify reasons | {"field":"disqualify_reasons","has_one_of":["Not a fit"]} |
| "disqualify_reasons" (UI: Disqualify reason is) | "has_any", "has_none" | true | {"field":"disqualify_reasons","has_any":true} |
| 'emails_received_from_admins_ids' | "has_one_of", "has_all_of", "has_none_of" | Array of admin IDs | {"field":"emails_received_from_admins_ids","has_one_of":[4256]} |
| 'emails_received_from_admins_ids' | "has_any", "has_none" | true | {"field":"emails_received_from_admins_ids","has_any":true} |
| 'emails_sent_to_admins_ids' | "has_one_of", "has_all_of", "has_none_of" | Array of admin IDs | {"field":"emails_sent_to_admins_ids","has_one_of":[4191]} |
| 'emails_sent_to_admins_ids' | "has_any" | true | {"field":"emails_sent_to_admins_ids","has_any":true} |
| "gdpr_expires_at" (UI: Expiring) | "lte" | {"field":"gdpr_expires_at","lte":1550185199} | |
| "gdpr_uncompleted_change_request_created_at" (UI: Correction requests) | "gte" | {"field":"gdpr_uncompleted_change_request_created_at","gte":0} | |
| "gdpr_uncompleted_removal_request_created_at" (UI: Removal requests) | "gte" | {"field":"gdpr_uncompleted_removal_request_created_at","gte":0} | |
| "has_cover_letter" (UI: Cover letter) | "eq" | true, false | {"field":"has_cover_letter","eq":true} |
| "has_cv" (UI: CV) | "eq" | true, false | {"field":"has_cv","eq":true} |
| "has_email" (UI: Email address) | "eq" | true, false | {"field":"has_email","eq":true}] |
| 'interviewers_ids' (UI: Evaluated by) | "has_one_of", "has_all_of", "has_none_of" | Array of admin IDs | {"field":"interviewers_ids","has_one_of":[4256]} |
| 'interviewers_ids' (UI: Evaluated by) | "has_any", "has_none" | true | {"field":"interviewers_ids","has_any":true} |
| "job_ids" (UI: In Job) | "has_one_of", "has_all_of", "has_none_of" | Array of job IDs | {"field":"jobs_ids","has_one_of":[165644]} |
| "job_ids" (UI: In Job) | "has_any", "has_none" | true | {"field":"jobs_ids","has_any":true |
| "open_questions_answers_hashes" (UI: Has answer to question) | "has_one_of", "has_all_of", "has_none_of" | {"field":"open_questions_answers_hashes","has_one_of":["5c1c55e149a3e8825c3c53902b8ee153"]} | |
| "open_questions_hashes" (UI: Has answer to question) | "has_one_of", "has_all_of", "has_none_of" | {"field":"open_questions_hashes","has_one_of":["8672ccba61b7d7d954d26799f72a8a5a"]} | |
| "positive_ratings" (UI: Evaluations) | "has_none", "has_any" | true | {"field":"positive_ratings","has_none":true} {"field":"positive_ratings","has_any":true} |
| "positive_ratings" (UI: Evaluations) | "gte" - Greater-than or equal to, "lte" - Less-than or equal to | Percentage values | {"field":"positive_ratings","gte":76,"lte":100} |
| "rating" (UI: Star rating) | "gte" - Greater-than or equal to, "lte" - Less-than or equal to | 1-5 | {"field":"rating","gte":4.01,"lte":5} |
| "rating" (UI: Star rating) | "has_any", "has_none" | true | {"field":"rating","has_none":true} |
| "source" (UI: Candidate origin) | "in" | ["career_site","email","manual","import"] | {"field":"source","in":["career_site"]} |
| 'sources_ids' (UI: Has Source tag) | "has_one_of", "has_all_of", "has_none_of" | Array of source IDs | {"field":"sources_ids","has_one_of":[19860]} |
| 'sources_ids' (UI: Has Source tag) | "has_any", "has_none" | true | {"field":"sources_ids","has_any":true} |
| "stages" (UI: In Stage) | "has_one_of", "has_all_of", "has_none_of" | Array of stage names | {"field":"stages","has_one_of":["Applied","Interview"]} |
| "stages" (UI: In Stage) | "has_any", "has_none" | true | {"field":"stages","has_any":true} |
| "status" (UI: Candidate Status) | "in", "not in" | ["Qualified", "Disqualified", "New"] | {"field":"status","in":["qualified"]} {"field":"status","not_in":["qualified"]} |
| 'tags_ids' (UI: Has tag) | "has_one_of", "has_all_of", "has_none_of" | Array of tag IDs | {"field":"tags_ids","has_one_of":[11069]} |
| 'tags_ids' (UI: Has tag) | "has_any", "has_none" | true | {"field":"tags_ids","has_any":true} |
| 'talent_pools_ids' (UI: In Talent Pool) | "has_one_of", "has_all_of", "has_none_of" | Array of talent pool IDs | {"field":"talent_pools_ids","has_one_of":[149039,148899,141103]} |
| 'talent_pools_ids' (UI: In Talent Pool) | "has_any", "has_none" | true | {"field":"talent_pools_ids","has_any":true} |
Additional notes
"all" searches the following fields of candidates:
- candidate name,
- email addresses
- phone numbers
- tags
- sources
- candidate offer assignments - returns candidates with assignments to offers fitting the query
- current stage name
- cover letter
- cv content