Calling this endpoint will return a collection of the company's candidates.

๐Ÿ“˜

Limits

A call without parameters returns 60 candidates - just like the default pagination in Recruitee

Maximum number of candidates that can be returned with a single call is 10 000 - setting the limit parameter above the limit will return "Server internal error"

๐Ÿ‘

Note for Time filters

When applying filters involving time (e.g., created_at), ensure you use Unix Time format. For easy conversion, refer to the Unix Time Stamp website. This requirement applies to all fields in the column Possible values marked timestamp.

Candidates search accepts filters in a form of JSON array.

FieldType of filterPossible valuesExample
allqueryany string{"field":"all","query":"Smith"}
average_scoregte (>=), gt (>), lte (<=), lt (<)percentage values{"field":"average_score","gte":76,"lte":100}
average_scorehas_any, has_none, has_hiddenTRUE{"field":"average_score","has_none":true} {"field":"average_score","has_any":true}
created_at (UI: Date created)gte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"field":"created_at","gte":1548975600,"lte":1549061999}
emails_received_from_admins_ids (UI: Candidate received emails from...)has_any, has_noneTRUE{"field":"emails_received_from_admins_ids","has_any":true}
emails_received_from_admins_ids (UI: Candidate received emails from...)has_one_of, has_all_of, has_none_ofarray of IDs{"field":"emails_received_from_admins_ids","has_one_of":[4256]}
emails_sent_to_admins_ids (UI: Candidate sent emails to...)has_any, has_noneTRUE{"field":"emails_sent_to_admins_ids","has_any":true}
emails_sent_to_admins_ids (UI: Candidate sent emails to...)has_one_of, has_all_of, has_none_ofarray of IDs{"field":"emails_sent_to_admins_ids","has_one_of":[4191]}
gdpr_expires_at (UI: Retention period ends within...)gte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"field":"gdpr_expires_at","gte":1548975600,"lte":1549061999}
gdpr_uncompleted_change_request_created_at (UI: Correction requests)gte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"field":"gdpr_uncompleted_change_request_created_at","gte":0}
gdpr_uncompleted_removal_request_created_at (UI: Removal requests)gte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"field":"gdpr_uncompleted_removal_request_created_at","gte":0}
has_cover_letter (UI: Cover letter)eqtrue, false{"field":"has_cover_letter","eq":true}
has_cv (UI: CV or resume)eqtrue, false{"field":"has_cv","eq":true}
has_email (UI: Email address)eqtrue, false{"field":"has_email","eq":true}
interviewers_ids (UI: Evaluated by)has_anyTRUE{"field":"interviewers_ids","has_any":true}
interviewers_ids (UI: Not evaluated by)has_noneTRUE{"field":"interviewers_ids","has_none":true}
interviewers_ids (UI: Evaluated by)has_one_of, has_all_ofarray of IDs{"field":"interviewers_ids","has_one_of":[4256]}
job_fit_score (UI: Job fit score)gte (>=), gt (>), lte (<=), lt (<)percentage values{"field":"job_fit_score","gte":76,"lte":100}
job_fit_score (UI: Job fit score)has_any, has_none, has_hiddenTRUE{"field":"job_fit_score","has_none":true} {"field":"job_fit_score","has_any":true}
last_activity_atgte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"field":"last_activity_at","gte":1548975600,"lte":1549061999}
positive_ratings (UI: Evaluations)gte (>=), gt (>), lte (<=), lt (<)percentage values{"field":"positive_ratings","gte":76,"lte":100}
positive_ratings (UI: Evaluations)has_any, has_noneTRUE{"field":"positive_ratings","has_none":true} {"field":"positive_ratings","has_any":true}
source (UI: Candidate origin)in, not_inarray of strings; ["career_site","email","manual","import"]{"field":"source","in":["career_site"]}
status (UI: Candidate Status)inarray of strings; ["Qualified", "Disqualified", "New"]{"field":"status","in":["qualified"]}
updated_atgte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"field":"updated_at","gte":1548975600,"lte":1549061999}
addresshas_any, has_noneTRUE{"filter":"address", "has_any":true}
address, text (UI: Address contains/does not contain)contains, not_containsarray of strings{"filter":"address", "text": {"contains":["street"]}}
admin, id (UI: Added by)has_anyTRUE{"filter":"admin","id":{"has_any":true}}
admin, id (UI: Added by)in, not_inarray of IDs{"filter":"admin", "id":{"not_in":[123]}}
boolean_* (candidate "*yes/no field title")has_any, has_noneTRUE{"filter":"boolean_is_available", "has_any":true}
boolean_* (candidate "*yes/no field title"), flageqtrue, false{"filter":"boolean_is_available", "flag":{"eq":true}}
date_of_birthhas_any, has_noneTRUE{"filter":"date_of_birth", "has_any":true}
date_of_birth, dategte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"date_of_birth", "date":{"lte":946684800}}
disqualifies, kindin, not_inarray of strings ("admin", "system"){"filter":"disqualifies", "kind":{"in":["admin"]}}
disqualifies, reasonhas_any, has_noneTRUE{"filter":"disqualifies", "reason":{"has_any":true}}
disqualifies, reasonin, not_in, all_inarray of strings{"filter":"disqualifies", "reason":{"in":["Not a fit"]}}
dropdown_* (candidate "*dropdown field title")has_any, has_noneTRUE{"filter":"dropdown_mentor", "has_any":true}
dropdown_* (candidate "*dropdown field title"), valuein, not_inarray of strings{"filter":"dropdown_mentor", "value":{"in":["John"]}}
educationhas_any, has_noneTRUE{"filter":"education", "has_any":true}
education, degree (UI: Degree contains/does not contain)contains, not_containsarray of strings{"filter":"education", "degree":{"contains":["major"]}}
education, descriptioncontains, not_containsarray of strings{"filter":"education", "description":{"contains":["programming"]}}
education, start_dategte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"education", "start_date":{"gte": 946684800}}
education, end_dategte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"education", "end_date":{"gte": 946684800}}
education, majorcontains, not_containsarray of strings{"filter":"education", "major":{"contains":["biology"]}}
education, schoolcontains, not_containsarray of strings{"filter":"education", "school":{"contains":["university"]}}
eeo_status, template_nameinarray of strings{"filter":"eeo_status", "template_name":{"in":["x"]}}
eeo_data_statusin{"filter":"eeo_data_status","in":["completed"]}
eventshas_any, has_noneTRUE{"filter":"events", "has_any":true}
events, kindin, not_inarray of strings; ["meeting","onsite","video", "call"]{"filter":"events", "kind":{"in":["meeting"]}}
events, starts_atgte (>=), gt (>), lte (<=), lt (<), not_gte, not_gt, not_lte, not_lttimestamp (string / number){"filter":"events", "starts_at":{"gte": 1549061999}}
experiencehas_any, has_noneTRUE{"filter":"experience", "has_any":true}
experience, companycontains, not_containsarray of strings{"filter":"experience", "company":{"contains":["Tellent"]}}
experience, descriptioncontains, not_containsarray of strings{"filter":"experience", "description":{"contains":["programming"]}}
experience, start_dategte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"experience", "start_date":{"gte": 1549061999}}
experience, end_dategte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"experience", "end_date":{"gte": 1549061999}}
experience, locationcontains, not_containsarray of strings{"filter":"experience", "location":{"contains":["London"]}}
experience, titlecontains, not_containsarray of strings{"filter":"experience", "title":{"contains":["manager"]}}
followers, idhas_any, has_noneTRUE{"field":"followers","has_any":true}
followers, idin, not_in, all_inarray of IDs{"filter":"followers","id":{"not_in":[123]}}
genderhas_any, has_noneTRUE{"filter":"gender", "has_any":true}
gender, valuein, not_inarray of strings{"filter":"gender", "value":{"in":["female"]}}
hiring, hired_atgte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"hiring", "hired_at":{"gte":946684800}}
hiring, job_starts_atgte (>=), gt (>), lte (<=), lt (<)timestamp (string / number){"filter":"hiring", "job_starts_at":{"gte":946684800}}
hiring, statusinarray of strings{"filter":"hiring", "status":{"in":["active"]}}
interviewers, idin, not_inarray of IDs (int){"filter":"interviewers","id":{"not_in":[4256]}}
jobshas_any, has_noneTRUE{"filter":"jobs", "has_any":true}
jobs, cityin, not_inarray of strings{"filter":"jobs", "city":{"in":["Chicago"]}}
jobs, country_codein, not_inarray of strings{"filter":"jobs", "country_code":{"in":["US"]}}
jobs, department_idhas_any, has_noneTRUE{"filter":"jobs", "department_id":{"has_any":true}}
jobs, department_idin, not_inarray of numbers / strings{"filter":"jobs", "department_id":{"in":[1758224]}}
jobs, idhas_any, has_none, has_any_followed, has_none_followedTRUE{"filter":"jobs", "id":{"has_any":true}}
jobs, idin, not_in, all_inarray of IDs (int){"filter":"jobs", "id":{"in":[1]}}
jobs, locations.idhas_any, has_noneTRUE{"filter":"jobs", "locations.id":{"has_any":true}}
jobs, locations.idin, not_inarray of IDs (int){"filter":"jobs", "locations.id":{"in":[2]}}
jobs, state_codein, not_inarray of strings{"filter":"jobs", "state_code":{"in":["AZ"]}}
jobs, statusin, not_inarray of strings{"filter":"jobs", "status":{"in":["applied"]}}
language_skillhas_any, has_noneTRUE{"filter":"language_skill", "has_any":true}
language_skill, language_codein, not_in, has_all_ofarray of strings{"filter":"language_skill", "language_code":{"in":["en"]}}
locations, idin, not_inarray of IDs (int){"filter":"locations", "id":{"in":[1]}}
multi_line_* (candidate "*multi-line field title")has_any, has_noneTRUE{"filter":"multi_line_interests", "has_any":true}
multi_line_* (candidate "*multi-line field title"), textcontains, not_containsarray of strings{"filter":"multi_line_interests", "text":{"contains":["swimming"]}}
nationalityhas_any, has_noneTRUE{"filter":"nationality", "has_any":true}
nationality, country_codein, not_inarray of strings{"filter":"nationality", "country_code":{"in":["US"]}}
potential_duplicateeqtrue, false{"filter":"potential_duplicate", "eq":true}
questionnaire_answershas_any, has_noneTRUE{"filter":"questionnaire_answers", "has_any":true}
questionnaire_answers, question_titlein, not_inarray of strings{"filter":"questionnaire_answers", "question_title":{"in":["Describe your experience"]}}
questionnaires_filledhas_any, has_noneTRUE{"filter":"questionnaires_filled", "has_any":true}
questionnaires_filled, template_namein, not_inarray of strings{"filter":"questionnaires_filled", "template_name":{"in":["Initial questionnaire"]}}
questionnaires_receivedhas_any, has_noneTRUE{"filter":"questionnaires_received", "has_any":true}
questionnaires_received, template_namein, not_inarray of strings{"filter":"questionnaires_received", "template_name":{"in":["Initial questionnaire"]}}
single_line_* (candidate "*single-line field title")has_any, has_noneTRUE{"filter":"single_line_region", "has_any":true}
single_line_* (candidate "*single-line field title"), textcontains, not_containsarray of strings{"filter":"single_line_region", "text":{"contains":["Europe"]}}
skillshas_any, has_noneTRUE{"filter":"skills", "has_any":true}
skills, textin, not_in, contains, not_contains, has_all_ofarray of strings{"filter":"skills", "text":{"in":["programming"]}}
sources, idhas_any, has_noneTRUE{"filter":"sources", "id":{"has_any":true}}
sources, idin, not_in, all_inarray of IDs (int){"filter":"sources", "id":{"in":[1]}}
stages, namehas_any, has_noneTRUE{"filter":"stages", "name":{"has_any":true}}
stages, namein, not_inarray of strings{"filter":"stages", "name":{"in":"Phone interview"}}
tags, id (UI: Has tag)has_any, has_noneTRUE{"filter":"tags", "id":{"has_any":true}}
tags, id (UI: Has tag)in, not_in, all_inarray of IDs (int){"filter":"tags", "id":{"in":[1]}}
talent_pools, idhas_any, has_none, has_any_followed, has_none_followedTRUE{"filter":"talent_pools", "id":{"has_any":true}}
talent_pools, idin, not_in, all_inarray of IDs (int){"filter":"talent_pools", "id":{"in":[1]}}
taskshas_any, has_noneTRUE{"filter":"tasks", "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
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!