Choose a search
Use
POST /v1/people/search for people and POST /v1/companies/search for companies. Send exactly one of query, filters, simple_filters, parsed_query, seeds or search_id; companies do not accept seeds.
Every search returns a Job. Use Search Results to read its items, page through them and export them.
Page a Search
Setpage_size from 1 to 100 to materialize one Search page per Job. The Job result includes the page’s raw rows in items, next_cursor, and page metadata, limits and totals. next_cursor is null when the page has no continuation. Submit a non-null cursor alone to the same people or company route to start the next page. The cursor carries the original Search and page size; it cannot be combined with a new source or Search options. The same rows remain available from GET /v1/jobs/{job_id}/items.
For natural-language searches, query_mode defaults to deep. Set query_mode to standard to use the standard Search planner. Omit page_size for the existing bulk Job behavior, which returns up to max_results records.
Run a search end to end
A Deep Search or Lookalike Search can take a few minutes, so the first response is often a Job that is stillrunning. A Filter Search usually finishes within the wait window. The steps are the same for every kind of search:
- Start the search. The response is a Job with a
job_id. - Poll
GET /v1/jobs/{job_id}untilstatusissucceeded,failedorcanceled. - Read the profiles from
GET /v1/jobs/{job_id}/items, followingnext_cursoruntil it is null. - To get a file, export the Job.
jq.
failed Job carries the reason in error. See Handling Errors.
Try it
Open the Search People API Reference playground.
Related
For the original routes, see Legacy Search.