Skip to main content
GET
Get a person

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

id
string
required

The person ID

Response

successful

id
string
required

The person ID

Example:

"abc123xyz"

book_id
string
required

The book ID

Example:

"book123xyz"

first_name
string
required
Example:

"John"

last_name
string
required
Example:

"Doe"

household_id
string | null

The household ID

Example:

"xyz789abc"

contact_id
string | null

The contact ID (present when person belongs to a contact)

Example:

"cnt456def"

role_type
enum<string> | null

The entity type this person belongs to

Available options:
client,
prospect,
contact,
past_client
Example:

"client"

middle_name
string | null
Example:

"Robert"

salutation
string | null
Example:

"Mr."

suffix
string | null
Example:

"Jr."

maiden_name
string | null
Example:

"Smith"

gender
enum<string> | null
Available options:
female,
male,
nonbinary,
other,
prefer_not_to_say
Example:

"male"

designations
string | null
Example:

"CPA, CFP"

household_role
enum<string> | null

Only present when person belongs to a household

Available options:
head_of_household,
partner,
spouse,
dependent_child,
other_adult,
other_dependent,
unknown,
deceased,
non_dependent_child,
grandchild
Example:

"head_of_household"

preferred_name
string | null
Example:

"Johnny"

date_of_birth
string<date> | null

Date of birth

Example:

"1985-06-15"

job_title
string | null

Job title

Example:

"Software Engineer"

ssn
string | null

Obfuscated social security number

Example:

"***-**-6789"

drivers_license_number
string | null

Obfuscated driver's license number

Example:

"******7890"

email_addresses
object[]

Array of email addresses with primary designation

phone_numbers
object[]

Array of phone numbers with primary designation

addresses
object[]

Array of addresses with primary designation

employments
object[]

Array of employment records

custom_fields
object

Custom field values as key-value pairs

Example: