v1
latestOpenAPI 3.0.32026-08-06224144516.1 KBCandidates
Filter candidates
This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call. For a more in-depth explanation of boolean filtering, consult the section near the top of this page dealing with filtering.
The following are all the Candidate fields that can currently be filtered on, and which filters can be used on each:
`id` - greater_than, less_than, between, exactly, is_empty
`first_name` - contains, exactly, is_empty
`middle_name` - contains, exactly, is_empty
`last_name` - contains, exactly, is_empty
`title` - contains, exactly, is_empty
`emails.primary` - contains, exactly, is_empty
`emails.secondary` - contains, exactly, is_empty
`address.street` - contains, exactly, is_empty
`address.city` - contains, exactly, is_empty
`address.state` - contains, exactly, is_empty
`address.postal_code` - geo_distance, contains, exactly, is_empty
`country_code` - contains, exactly, is_empty
`phones.home` - contains, exactly, is_empty
`phones.cell` - contains, exactly, is_empty
`phones.work` - contains, exactly, is_empty
`best_time_to_call` - contains, exactly, is_empty
`current_employer` - contains, exactly, is_empty
`date_available` - greater_than, less_than, between, is_empty
`current_pay` - contains, exactly, is_empty
`desired_pay` - contains, exactly, is_empty
`is_willing_to_relocate` - exactly, is_empty
`key_skills` - contains, exactly, is_empty
`notes` - contains, exactly, is_empty
`is_hot` - exactly, is_empty
`contact_id` - greater_than, less_than, between, exactly, is_empty
`owner_id` - greater_than, less_than, between, exactly, is_empty
`entered_by_id` - greater_than, less_than, between, exactly, is_empty
`date_created` - greater_than, less_than, between, is_empty
`date_modified` - greater_than, less_than, between, is_empty
`resumes` - contains
`resumes.name` - contains, exactly, is_empty
post/candidates/search
Query parameters
querystring required
The optional string to search within candidates for.
pagenumber required
The current page number of candidates to return.
per_pagenumber required
The number of candidates to return per page.
Request body
Response
OK