Skip to main content
GET
Get a person

Authorizations

Authorization
string
header
required

Short-lived access token minted by POST /v1/oauth/token.

Path Parameters

party_id
string
required

Response

Successful Response

Detailed person record with contact methods and current addresses.

id
string
required

The person's unique party ID.

display_name
string
required

The person's client-facing display name.

first_name
string
required

The person's first name.

last_name
string
required

The person's last name.

is_active
boolean
required

Whether the person is active.

date_of_birth
string<date> | null

The person's date of birth.

ssn_last_four
string | null

Last four SSN digits; the full hash is never exposed.

primary_phone
string | null

Preferred active phone, or newest active phone.

primary_email
string | null

Preferred active email, or newest active email.

preferred_language
string | null

Preferred language code.

contact_methods
ContactMethodRow · object[]

Active client-safe phone and email methods.

addresses
AddressRow · object[]

Current client-safe addresses.