Skip to main content
POST
people.search-bulk

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

Domain of the company the people work at, e.g. figma.com.

title
string

Job title, e.g. engineering manager.

Required string length: 1 - 256
fullName
string

The person's full name.

Required string length: 1 - 256
country
string

Two-letter country code like US, applied where the data source supports it.

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

Free-text place, e.g. "London, United Kingdom".

Required string length: 1 - 256
keywords
string[]

Skills or topics the people should match, up to 20.

Maximum array length: 20
Required string length: 1 - 128
maxRows
integer
default:100

How many people the job may deliver, 1 to 10000. The job stops there and is limited to it upstream. Default 100. Each delivered person costs the same as a page-search result; the keywords filter adds a little more.

Required range: 1 <= x <= 10000

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.