Skip to main content
POST
people.profile.search

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
filters
object[]
required

Typed predicates combined with AND. Unsupported field/operator combinations are declined.

Required array length: 1 - 30 elements
datasets
enum<string>[]

Slices to include; default professional resume records.

Required array length: 1 - 8 elements

Dataset slice.

Available options:
all,
resume,
email,
phone,
mobile_phone,
consumer_social,
developer,
street_address
excludeDatasets
enum<string>[]

Slices to exclude.

Maximum array length: 7

Excluded slice.

Available options:
resume,
email,
phone,
mobile_phone,
consumer_social,
developer,
street_address
groups
enum<string>[]

Explicit field groups. Default professional. Private contact, address, demographic and compensation groups are opt-in. Histories and arrays are capped at 50 entries.

Required array length: 1 - 12 elements

One field group.

Available options:
professional,
employmentHistory,
education,
skills,
languages,
socialProfiles,
workEmail,
personalEmails,
phones,
residentialAddresses,
demographics,
compensation
limit
integer
default:10

Results per page, 1 to 50. Default 10.

Required range: 1 <= x <= 50
cursor
string

Protected continuation from the same filters, groups and page size; expires in 24 hours.

Required string length: 1 - 4096

Response

The result

results
object[]
required

Matched people with selected groups.

Maximum array length: 50
total
integer

Total matching records when reported.

Required range: 0 <= x <= 9007199254740991
nextCursor
string

Protected continuation, valid for 24 hours.