Skip to main content
POST
people.search-preview

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

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

Required string length: 1 - 64
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
limit
integer
default:25

How many masked sample rows to fetch, 25 to 100. Default 25. One page is billed flat whatever it holds.

Required range: 25 <= x <= 100

Response

The result

results
object[]
required

The masked sample page.

totalMatches
number
required

How many people match the filters in total, uncapped.

page
number
required

The zero-based page these samples came from.