Skip to main content
POST
people.emails.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
companyName
string

Company names, comma-separated.

Required string length: 1 - 256
country
string

Two-letter country code like US.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
industry
string

Industry id from the source's industry catalog.

Required string length: 1 - 64
headcount
string

Company size bucket: one of "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001+".

Required string length: 1 - 16
companyType
string

Company type, e.g. privately held, public company.

Required string length: 1 - 64
foundedYear
string

Founding years, comma-separated.

Required string length: 1 - 16
technology
string

Technology slug the companies' sites use.

Required string length: 1 - 64
department
string

Department, e.g. sales, marketing, executive.

Required string length: 1 - 64
seniority
string

Seniority levels, comma-separated: junior, senior, executive.

Required string length: 1 - 64
type
enum<string>

Only personal or only generic (role) addresses.

Available options:
personal,
generic
decisionMaker
boolean

Only likely decision makers.

verificationStatus
string

Only addresses with these verification statuses, comma-separated: valid, accept_all, unknown.

Required string length: 1 - 64
requiredField
string

Only rows that carry every listed field, comma-separated: full_name, position, phone_number.

Required string length: 1 - 128
minConfidence
number

Minimum confidence for the address, 2 to 100.

Required range: 2 <= x <= 100
limit
number

How many rows to return, 1 to 100. Default 50.

Required range: x >= 1
cursor
string

The nextCursor a previous page returned; fetches that next page.

Required string length: 1 - 1024

Response

The result

results
object[]
required

The matching rows, addresses still unrevealed.

total
number

How many rows match the filters in total.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.