/company/{id}/candidates/search

Searches a company's candidates across all positions, accepting the same parameters as the GET form but in a JSON body.

The endpoint has two modes:

  • email_address — exact match on the normalized (lowercased, trimmed) email address, company-wide. This mode takes precedence when both parameters are supplied and returns a bare array of reduced candidate entries (the { total, data } envelope is not used), identical to the GET email lookup.
  • filter_text — free-text search across the company's candidates via OpenSearch, returning the paginated { total, data } envelope described below. Each entry in data is a full candidate list summary (id, name, contact info, stage, source, score, tags, etc.) with the associated position attached.

At least one of email_address or filter_text is required; a request with neither returns 400. sort must be created or updated (defaults to updated); any other value returns 400. Pagination applies to the free-text mode only: page_size defaults to 50 and is capped at 50, and page defaults to 0 and is clamped to a maximum of 19 (20 pages). archived defaults to true so the search spans the company's full candidate history; set it to false to exclude archived candidates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json