Skip to main content
POST
people.search-export

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

Free-text description of the people. Some sources cannot serve this.

Required string length: 1 - 256
domain
string

Company website domain the people work at, e.g. figma.com.

title
string

Job title to match, e.g. Chief Financial Officer.

Required string length: 1 - 256
fullName
string

The person's full name.

Required string length: 1 - 256
country
string

Country name or two-letter code, e.g. US.

Required string length: 1 - 64
location
string

City or place name, e.g. Dublin or Oregon, United States.

Required string length: 1 - 256
keywords
string[]

Keywords from the person's profile, e.g. kubernetes.

Maximum array length: 5
Required string length: 1 - 64
maxRows
integer
default:1000

How many rows to export, 1 to 50000. Default 1000. Every exported row is billed, so ask for more only when you need them.

Required range: 1 <= x <= 50000

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.