Skip to main content
POST
people.profile.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
ref
string
required

The ref returned by people.profile.details-extended, people.profile.search or people.enrich-availability.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
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

Response

The result

person
object
required

Person and explicitly selected field groups.