Skip to main content
POST
Search the professional people database by filters or a plain-language description.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json
companyId
string
required

Company ID for access and any applicable data-credit charges

filters
object

Person and company filters keyed by the camelCase field names from leads_listFieldOptions, e.g. {"title": ["Head of Marketing"], "seniority": ["Director"], "companyDomain": ["acme.com"], "employeeRange": ["51-200"], "country": ["US"]}. Text and enum filters take a list of values (any value matches); different filters must all match. Enum values must come from leads_listFieldOptions; countries are two-letter codes. Number filters take a single number. At least one positive (non-exclude) filter is required. Send filters or query, not both.

query
string

AI search: a plain-language description of the people to find, e.g. "engineers in New York at software companies with more than 500 employees". Turned into filters by AI (uses AI credits), then searched. Page 1 only; the response returns the filters used, so request later pages with those filters and nextCursor.

page
integer
default:1

1-based page number. Page 1 needs no cursor; later pages need the previous response's nextCursor.

pageSize
integer
default:25

Results per page: 5, 10, 25, 50. Default: 25.

cursor
string

nextCursor from the previous response. Required for page > 1; keep filters, companyId and pageSize unchanged.

Response

Paginated people database matches

items
object[]

Matching people: name, title, company, location, linkedinUrl and other profile fields, as text. No emails or phones. Pass items back unchanged as rows to import or export them.

total
integer

Total people matching the filters

page
integer
pageSize
integer
creditCost
integer

Always zero; people search is free. Importing costs one data credit per record and enriches emails.

nextCursor
string

Continuation cursor; null means the end of the results

filters
object

The normalized filters that were searched. For an AI search, these are the filters it chose; send them with nextCursor for later pages.