Endpoint
The endpoint for the Person Search API ishttps://api.peopledatalabs.com/v5/person/search.
Person Search API Access and Billing
We charge per record retrieved. Each person record in thedata array of the response counts as a single credit against your total package.
Requests
See Authentication and Requests to learn how to input requests. We recommend using a JSON object to capture request parameters and will do so in the examples.Rate Limiting
The current default rate limit is 10 requests per minute.Input Parameters
For more details, see Input Parameters - Person Search APIYou can also click on the individual parameter names in the table below to view more information on them.
| Parameter Name | Description | Default | Example |
|---|---|---|---|
query | An Elasticsearch (v7.7) query. See our underlying Elasticsearch mapping for reference. | {"query": {"term": {"job_company_name": "people data labs"}}} | |
sql | An SQL query of the format: SELECT * FROM person WHERE XXX, where XXX is a standard SQL boolean query involving our person fields. We will ignore any use of column selections or the LIMIT keyword. | SELECT * FROM person WHERE job_company_name='people data labs' | |
size | The batch size or the maximum number of matched records to return for this query if they exist, which must be between 1 and 100. | 1 | 100 |
from | The from field is not recommended for use and will not be supported long term. Use the scroll_token field instead**An offset value for paginating between batches, which can be a number between0 and 9999. You can execute pagination for a maximum of 10,000 records per query. NOTE: YOU CANNOT USE FROM WITH SCROLL_TOKEN IN THE SAME REQUEST. | 0 | 0, 100, 200 … |
scroll_token | An offset key for paginating between batches. Unlike the legacy from parameter, you can use this parameter for any number of records. Each Person Search API response returns a scroll_token, which you can use to fetch the next size records. | None | 104$14.278746 |
dataset | Specifies which dataset the API should search against. You can input multiple datasets by separating them with a comma. Valid names are resume, email, phone, mobile_phone, street_address, consumer_social, developer and all. You can also exclude datasets by using - as the first character. | resume | all |
titlecase | All text in the data of API responses returns as lowercase by default. Setting titlecase to true will titlecase any records returned. | false | true |
pretty | Whether the output should have human-readable indentation. | false | true |
api_key | Your secret API key. Note: you can also provide this in the request header instead, as shown on the Authentication page. |
Output Response
The API will return an HTTP response code of200 for any valid request, regardless of whether it found records for your query or not. For that reason, pay close attention to the total value in your response object to understand query success. Each person record in the data array of the response counts as a single credit against your total package. The responses in the output are sorted by profile completeness.
Response Fields
For more details, see Output Response - Person Search APIYou can also click the field names in the table below to view more information on them.
Response Data Structure
The response from the Person Search API will be in this format:JSON
data object.