People Data Labs

Usage Instructions

Enrich a single person or company with People Data Labs, or search the global person and company datasets with SQL or Elasticsearch DSL. Useful for sales enrichment, contact lookup, and CRM hygiene.

Tools

`pdl_person_enrich`

Enrich a single person profile using People Data Labs. Match by email, phone, LinkedIn URL, or name + company/location. Returns work history, contact details, location, and skills.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`email`	string	No	Email address to match
`phone`	string	No	Phone number (E.164 format preferred)
`profile`	string	No	LinkedIn profile URL
`lid`	string	No	LinkedIn numeric ID
`name`	string	No	Full name (use as an alternative to first_name + last_name)
`first_name`	string	No	First name (use with last_name + company or location)
`last_name`	string	No	Last name
`company`	string	No	Company name or website
`school`	string	No	School name
`location`	string	No	Location name (city, region, or country)
`min_likelihood`	number	No	Minimum match likelihood (1-10)
`required`	string	No	Required-fields expression (e.g., "emails AND job_title")
`titlecase`	boolean	No	Return name fields in title case

Output

Parameter	Type	Description
`matched`	boolean	Whether a person record was matched
`likelihood`	number	Match likelihood score (1-10), null if no match
`person`	object	Matched person record

Return up to 20 candidate person matches with confidence scores. Useful when you want to see all plausible matches rather than the single best one. Reference: https://docs.peopledatalabs.com/docs/identify-api-quickstart

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`email`	string	No	Email
`phone`	string	No	Phone number
`profile`	string	No	LinkedIn profile URL
`email_hash`	string	No	SHA-256 email hash
`lid`	string	No	LinkedIn numeric ID
`name`	string	No	Full name
`first_name`	string	No	First name
`middle_name`	string	No	Middle name
`last_name`	string	No	Last name
`company`	string	No	Company name or website
`school`	string	No	School
`location`	string	No	Location
`street_address`	string	No	Street address
`locality`	string	No	City
`region`	string	No	State/region
`country`	string	No	Country
`postal_code`	string	No	Postal code
`birth_date`	string	No	Birth date (YYYY-MM-DD)
`data_include`	string	No	Comma-separated fields to include in each match
`include_if_matched`	boolean	No	Include `matched_on` for each match
`titlecase`	boolean	No	Return name fields in title case

Output

Parameter	Type	Description
`matches`	array	Up to 20 candidate matches, ordered by score

`pdl_person_search`

Search the People Data Labs person dataset using SQL or Elasticsearch DSL. Returns up to 100 matching records per call.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`sql`	string	No	PDL SQL query (e.g., "SELECT * FROM person WHERE job_title='engineer' AND location_country='united states'")
`query`	string	No	Elasticsearch DSL query as JSON string. Use either sql or query, not both.
`size`	number	No	Number of results to return (1-100, default 1)
`scroll_token`	string	No	Pagination token returned from a prior response
`dataset`	string	No	Dataset filter: all, resume, email, phone, mobile_phone, street_address, consumer_social, developer (combinable with commas, exclude with `-` prefix)
`titlecase`	boolean	No	Return name fields in title case

Output

Parameter	Type	Description
`total`	number	Total matching records in dataset
`scroll_token`	string	Pagination token to fetch the next page; null if no more results
`results`	array	Person records matching the query

`pdl_bulk_person_enrich`

Enrich up to 100 person records in a single call. Provide a JSON array of request objects, each with a params object (and optional metadata echoed back). Reference: https://docs.peopledatalabs.com/docs/bulk-person-enrichment-api

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`requests`	string	Yes	JSON array of request objects, max 100. Each item: { "params": { email \| profile \| first_name+last_name+company \| ... }, "metadata": {...optional...} }
`required`	string	No	Required-fields expression applied globally to every request

Output

Parameter	Type	Description
`results`	array	Per-record results in the same order as the input requests

`pdl_company_enrich`

Enrich a single company using People Data Labs. Match by name, website, LinkedIn URL, ticker, or PDL ID.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`name`	string	No	Company name
`website`	string	No	Company website domain
`profile`	string	No	LinkedIn company URL
`ticker`	string	No	Stock ticker
`pdl_id`	string	No	PDL company ID
`location`	string	No	Company location (helps disambiguate)
`locality`	string	No	City
`region`	string	No	State/region
`country`	string	No	Country
`min_likelihood`	number	No	Minimum match likelihood (1-10)
`required`	string	No	Required-fields expression
`titlecase`	boolean	No	Return name fields in title case

Output

Parameter	Type	Description
`matched`	boolean	Whether a company record was matched
`likelihood`	number	Match likelihood score (1-10), null if no match
`company`	object	Matched company record

`pdl_company_search`

Search the People Data Labs company dataset using SQL or Elasticsearch DSL. Returns up to 100 matching companies per call.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`sql`	string	No	PDL SQL query (e.g., "SELECT * FROM company WHERE industry='computer software' AND size='51-200'")
`query`	string	No	Elasticsearch DSL query as JSON string
`size`	number	No	Number of results to return (1-100, default 1)
`scroll_token`	string	No	Pagination token returned from a prior response
`titlecase`	boolean	No	Return name fields in title case

Output

Parameter	Type	Description
`total`	number	Total matching companies in dataset
`scroll_token`	string	Pagination token to fetch the next page; null if no more results
`results`	array	Company records matching the query

`pdl_bulk_company_enrich`

Enrich up to 100 companies in a single call. Provide a JSON array of request objects, each with a params object. Reference: https://docs.peopledatalabs.com/docs/bulk-company-enrichment-api

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`requests`	string	Yes	JSON array of request objects, max 100. Each item: { "params": { name \| website \| profile \| ticker \| pdl_id }, "metadata": {...optional...} }
`required`	string	No	Required-fields expression applied globally to every request

Output

Parameter	Type	Description
`results`	array	Per-record results in the same order as the input requests

`pdl_clean_company`

Normalize a company string into a canonical company record. Provide at least one of name, website, or profile (LinkedIn URL).

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`name`	string	No	Raw company name to normalize
`website`	string	No	Company website
`profile`	string	No	LinkedIn company URL

Output

Parameter	Type	Description
`matched`	boolean	Whether the input was matched to a known company
`company`	object	Canonical company record

`pdl_clean_location`

Normalize a freeform location string into a structured locality/region/country record with coordinates.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`location`	string	Yes	Raw location string (e.g., "SF, CA")

Output

Parameter	Type	Description
`matched`	boolean	Whether the input was matched to a known location
`location`	object	Canonical location record

`pdl_clean_school`

Normalize a school string into a canonical school record. Provide at least one of name, website, or profile (LinkedIn URL).

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`name`	string	No	Raw school name to normalize
`website`	string	No	School website
`profile`	string	No	LinkedIn school URL

Output

Parameter	Type	Description
`matched`	boolean	Whether the input was matched to a known school
`school`	object	Canonical school record

`pdl_autocomplete`

Get autocomplete suggestions for a PDL field (title, skill, company, industry, location, school, major, role, sub_role).

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	People Data Labs API key
`field`	string	Yes	Field to autocomplete: all_location, class, company, country, industry, location_name, major, region, role, school, sub_role, skill, title, website
`text`	string	No	Search text prefix
`size`	number	No	Number of suggestions to return (1-100, default 10)
`titlecase`	boolean	No	Return name fields in title case

Output

Parameter	Type	Description
`suggestions`	array	Autocomplete suggestions ordered by frequency

Notes

Category: tools
Type: peopledatalabs

People Data Labs

Usage Instructions

Tools

`pdl_person_enrich`

Input

Output

`pdl_person_identify`

Input

Output

`pdl_person_search`

Input

Output

`pdl_bulk_person_enrich`

Input

Output

`pdl_company_enrich`

Input

Output

`pdl_company_search`

Input

Output

`pdl_bulk_company_enrich`

Input

Output

`pdl_clean_company`

Input

Output

`pdl_clean_location`

Input

Output

`pdl_clean_school`

Input

Output

`pdl_autocomplete`

Input

Output

Notes

On this page