PersonSearchRequest
queryobject · requiredRequired. Elasticsearch-style query DSL for searching. Supports bool queries with filter, must, must_not, and should clauses. Use terms, match, match_phrase, exists, range, and other Elasticsearch query types.
sizeinteger · min: 1 · max: 100Number of results to return (1-100)
Default: 10frominteger · min: 0Offset for pagination
Default: 0scroll_tokenstringToken for scrolling through large result sets
sortobject[]Array of sort specifications. Each item can specify a field and order (asc/desc). Defaults to sorting by relevance score (desc).
Default: [{"_score":"desc"}]
PersonSearchResponse
statusintegerHTTP status code
totalintegerTotal number of matching results
scroll_tokenstringToken for pagination (if more results available)
dataobject[]Array of person records
PersonEnrichRequest
pdl_idstringUnique person identifier
first_namestringFirst name of the person
last_namestringLast name of the person
middle_namestringMiddle name of the person
full_namestringFull name of the person
emailstringEmail address
phone_numberstringPhone number (E.164 format recommended)
job_titlestringJob title or role
company_namestringCompany name
locationstringLocation (city, state, country, etc.)
schoolstringSchool or university name
profilestring[]Array of social profile URLs (LinkedIn, Twitter, etc.)
min_likelihoodinteger · min: 1 · max: 10Minimum match threshold (1-10)
include_if_matchedbooleanReturn only if match found
Default: false
PersonEnrichResponse
statusintegerHTTP status code
likelihoodintegerMatch likelihood score (1-10)
dataEnriched person record, or null if no match found
dataset_versionstringDataset version identifier, if applicable
PersonEnrichData
idstringUnique person identifier
full_namestringFull name
first_namestringFirst name
middle_initialstringMiddle initial
middle_namestringMiddle name
last_initialstringLast initial
last_namestringLast name
sexstringSex (e.g., female, male)
birth_yearintegerBirth year
birth_datestringBirth date
work_emailstringWork email address
personal_emailsstring[]Personal email addresses
recommended_personal_emailstringRecommended personal email
mobile_phonestringMobile phone number
location_namestringFull location name (e.g., city, region, country)
location_localitystringLocality (city)
location_metrostringMetro area
location_regionstringRegion (state/province)
location_countrystringCountry
location_continentstringContinent
location_street_addressstringStreet address
location_address_line_2stringAddress line 2
location_postal_codestringPostal code
location_geostringGeo coordinates (lat,lon)
location_last_updatedstringWhen location was last updated (YYYY-MM-DD)
phone_numbersstring[]Phone numbers
emailsobject[]Emails with type (e.g., professional)
location_namesstring[]Location names
regionsstring[]Regions
countriesstring[]Countries
street_addressesstring[]Street addresses
Person
idstringUnique person identifier
full_namestringFull name
first_namestringFirst name
last_namestringLast name
middle_namestringMiddle name
emailstringPrimary email address
emailsstring[]Array of email addresses
phonesstring[]Array of phone numbers (alternative to phone_numbers)
phone_numbersstring[]Array of phone numbers
job_titlestringCurrent job title
companystringCurrent company name (alternative to company_name)
company_namestringCurrent company name
locationstringLocation string (e.g., 'Bengaluru, India')
location_namesstring[]Array of location names
profilesSocial media profiles (can be object or array format)
educationobject[]Education history
experienceobject[]Work experience history
skillsstring[]List of skills
interestsstring[]List of interests
SocialProfile
networkstringSocial network name (e.g., linkedin, twitter, github)
urlstringProfile URL
usernamestringUsername on the platform
Education
schoolstringSchool or university name
degreesstring[]Array of degrees obtained
start_datestring · dateStart date (YYYY-MM-DD)
end_datestring · dateEnd date (YYYY-MM-DD)