Sign in

v3

latestOpenAPI 3.1.02026-07-318648277.6 KB
People Enrichment

People Search

Canonical V3 people lookup with all company, title, role, people, channel, and contact-detail filters.

post/v3/people/search

Request body

company_domainstring
company_namestring
linkedin_urlstring

B2B company profile URL or slug.

company_filtersobject

Criteria-based company set. Supports the full Company Search filter family.

people_filtersobject

People-level filters for names, title/function/level, geography, profile URLs, headline/about-me/industry, languages, seniority, connection count, and channel availability. Canonical keys use the contact_* prefix (e.g. contact_linkedin_about_me); bare aliases such as about_me, headline, industry, job_function, and city are accepted. contact_job_function accepts short chips (Sales, Marketing, Finance, …) or full standard labels (Sales & Business Development, …); matching is exact after chip→label expansion and response rows always return the standard label. Multiple values in one array are OR'd; different people_filters keys in one request are AND'd. Keys the search cannot honor are echoed in interpreted_search.ignored_people_filters rather than silently dropped.

titlestring
job_titlestring
titlesstring[]
rolesstring[]
querystring

Free-text people/title query.

required_emailboolean

Only return people with email availability.

required_mobileboolean

Only return people with mobile availability.

channelsstring[]

Legacy alias for contactability requirements.

channel_match'any' | 'all'
include_companyboolean
include_domain_intelboolean
include_contact_detailsboolean

Opt in to paid raw email/mobile fields (alias — full_search). Bills 1 extra credit per returned email and 5 per returned mobile; base results are 1 credit per returned person. Search RPS / unmetered people-search plans cannot unlock email or mobile (403); unlocks require a credit-metered plan.

include_emailboolean

When contact details are on, return and bill raw emails (+1 credit each). If neither include_email nor include_mobile is set, both default to true. If either flag is set, the omitted flag defaults to false (include_email=true alone is email-only).

include_mobileboolean

When contact details are on, return and bill raw mobiles (+5 credits each). Same default rules as include_email.

confirm_credit_chargeboolean

Accepted for backwards compatibility; does not bypass RPS/unmetered unlock restrictions.

limitinteger

Offset requests allow up to 10000 rows; cursor-based pages are capped at 50.

cursorstring

Opaque signed next_cursor from the previous page. Send unchanged with the same filters, a limit no greater than 50, and offset 0.

offsetinteger

Example request

{
  "company_domain": "leadmagic.io",
  "company_name": "LeadMagic",
  "linkedin_url": "https://www.example.com/company/acme/",
  "title": "VP Sales",
  "job_title": "Head of Revenue"
}

Response

People search results

messagestring
credits_consumednumber
credit_previewobject
companiesobject[]
countinteger
returned_countinteger
limit_appliedinteger
offsetinteger
has_moreboolean
next_cursorstring nullable
metadataobject