Skip to main content

Input Parameters

Required Parameters

You must provide either the query or the sql parameter (but not both) to receive a successful response. We recommend using the Elasticsearch query parameter for most use cases.

When you execute an API request, the query runs directly against our Person Dataset without any cleaning or preprocessing. This means that you have a lot of freedom to explore the dataset and return the perfect records for your particular use case. It also means that you will need to understand the available fields to make successful queries.

Use the field descriptions on the Person Schema  to help write better queries.

To help you identify how to best query for related entities (companies), we offer a suite of company API.

We also provide a free Query Builder Tool that allows you download data without using our APIs.  You can still use this to generate an API query.

Cookie Notice

We and third parties such as our customers, partners, and service providers use cookies and similar technologies (\"cookies\") to provide and secure our Services, to understand and improve their performance, and to serve relevant information. For more information, see our Cookie Policy.

Back to top