Skip to main content
POST
companies.email-format.get

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
domain
string

Company domain, such as example.com.

companyName
string

Company name, instead of a domain.

Required string length: 1 - 200

Response

The result

domain
any
required

The resolved company domain.

pattern
string
required

Address naming pattern, such as first.last; no individual email is returned.

Maximum string length: 128
Pattern: ^(?:first|last|middle|initial|first_name|last_name|middle_name|f|l|m)(?:[._+-]?(?:first|last|middle|initial|first_name|last_name|middle_name|f|l|m))*$
confidenceLabel
enum<string>

Categorical confidence in the naming pattern.

Available options:
high,
medium,
low,
unknown
alternatePatterns
object[]

Up to 20 alternate naming patterns.

Maximum array length: 20