Choose a search
Use
POST /v1/people/search for people and POST /v1/companies/search for companies. Send exactly one of query, filters, 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.
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.