Skip to main content
POST
people.email.reveal

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
ref
string
required

The ref returned by a row of people.emails.search.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

email
string
required

The email address behind the row.

type
enum<string>

personal: one person's mailbox. generic: a role mailbox.

Available options:
personal,
generic
firstName
string

The person's first name, when known.

lastName
string

The person's last name, when known.

position
string

The person's job title, when known.

phoneNumber
string

The person's phone number, when published.

linkedinUrl
string

The person's LinkedIn profile URL, when known.

domain
string

Company website domain the address belongs to.

companyName
string

Company name, when known.

alreadyRevealed
boolean

True when the address was already unlocked earlier and the call is free.