The Person Search API gives you access to every profile in our full Person Dataset, which you can filter and segment using a search query. You can build a search query from any fields in the Person Schema to target only the person profiles that you are interested in.
Note, one credit is consumed for each person returned.
What does it do?
GET /personsearch/
Cost: 1 credit / 1 match
Searches LeadHootz dataset for people that match your query.
When would I use it?
I have: a set of critieria for people.
I want: to find people who meet my criteria.
For e.g. I have job posting. I want to find 1000 people that meet the job requirements.
Please check out the following pages for more information on the Person Search API:
| PAGE | DESCRIPTION |
|---|---|
| Quickstart | A quick hands-on introduction to the API with simple code examples. |
| Reference | Detailed descriptions of the technical specifications and usage constraints. |
| Input Parameters | In-depth explanations of the input parameters that the API supports. |
| Output Response | In-depth explanations of the output response object that the API returns. |
| Examples | A collection of functional code examples and walkthroughs that illustrate various use cases and applications of the API. |
| FAQs | Answers to commonly asked questions and other good-to-know information. |
| Preview Search API | A supporting functionality to preview which fields have non-null data for a particular search. |
The PersonSearch API is fully feature get request that comprises the vast majority of parameters needed for any professional search platform.
| Key | Value | Description |
|---|---|---|
| locationIds | [238,239] | specify required locations (int) |
| industryIds | 1|34|89 | specify required industries (int) |
| positionIds | 11369|11345 | specifies required positions (int) |
| emailTypeId | 1 | specifies (1) Work, (2) Private |
| phoneTypeId | 1 | specifies required (1) Mobile, (2) Telephone (int) |
| locationList | [Liverpool:United Kingdom|Washington:United States] | specifies required [countries : cities] (string) |
| industryList | [Wireless|Wholesale] | specifies required industries (string) |
| positionList | [director|chief exec] | specifies required positions (string) |
| isFB | 1 | specifies the results must return a Facebook ID (int) |
| isX | 1 | specifies the results must return X ID (int) |
| headCount | [11-50|51-200] | specifies the required head count range (string) |
| ageRange | [20-30|31-40] | specifies the required age range (string) |
| gender | 0 | specfies the required gender (1) male, (2) female (int) |
| experience | [1|1-3] | specifies required years experience (string) |
| salary | [25,000-35,000] | specifies required salary range (string) |
| skills | [Excel|Access] | specifies required skills (string) |
| companyId | [17257780|12969643|48308273] | specifies required company the person is in. (string) |
| skip | 100 | skip: used for paging results to ensure the next batch (int) |
Example request that returns person in Liverpool (United Kingdom) and Washington (United States) that are directors or chief executives.
?locationList=[Liverpool:United Kingdom|Washington:United States]&positionList=[director|chief exec]
Response
[
{
"title": "Mr",
"name": "John",
"surname": "Covert",
"domain": null,
"email": "[email protected]",
"linkedIn": "johncovert",
"twitter": null,
"industryId": 73,
"industries": null,
"pastCompany": "Sterne, Kessler, Goldstein & Fox",
"school": null,
"profileLanguage": null,
"serviceCategories": null,
"locality": "Washington, District Of Columbia, United States",
"cityId": 82449,
"cities": {
"name": "Washington",
"countryId": 239,
"countries": null,
"regionId": 314,
"regions": null,
"id": 82449,
"createdAt": "2022-11-12T02:21:01.3609847"
},
"street": "1100 new york avenue northwest",
"countryId": 239,
"countries": null,
"regionId": null,
"regions": null,
"postcode": null,
"ipAddress": null,
"position": "Director",
"gender": "male",
"birthDate": null,
"experience": "Patent Examiner, Director, Biotech And Chemical Practice Group Leader",
"workEmail": "[email protected]",
"facebookId": "1549484302",
"facebookUsername": "john.covert.33",
"inferredSalary": "150,000-250,000",
"inferredYearsExperience": 32,
"locationGeo": "38.89,-77.03",
"language": "[]",
"phone": "+17037952546",
"mobile": null,
"summary": "I am a director and co-chair of Sterne Kessler’s Biotechnology & Chemical Practice Group.",
"skills": "Patents, Patent Prosecution, Intellectual Property, Due Diligence, Pharmaceutical Industry",
"linkedInConnections": 915,
"dataSourceType": 4,
"whenUpdated": "2023-03-02T22:13:23.8033333",
"companyId": 792519,
"company": null,
"birthYear": 0,
"statusType": 0,
"bounceResponseType": 0,
"profileImage": null,
"profileImageMapping": null,
"currentCompanyId": null,
"currentCompanies": null,
"pastCompanyId": null,
"pastCompanies": null,
"positionId": 10576,
"positions": null,
"emailStatus": null,
"workEmailStatus": null,
"linkedInStatus": null,
"twitterStatus": null,
"facebookStatus": null,
"mobileStatus": null,
"phoneStatus": null,
"lastPost": null,
"lastPostDate": null,
"id": 23768484,
"createdAt": "2021-08-15T08:35:46.349448"
}
]
Need an API Key?
If you don't have an API key, you can easily create one by signing up for a self-serve account. For more information, check out our Quickstart Guide, which walks you through the sign-up process as well as shows you how to use the self-serve API dashboard.
Want a simpler way to get the data?
If you don't want the hassle of integrating our API. Why not just use our "pay as you go" list builder wizard.
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.