API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Individuals

List all individuals (client profiles)

client.individuals.list(IndividualListParams { household_id, is_primary, limit, offset } query?, RequestOptionsoptions?): IndividualList { data, pagination }

get/individuals

Create a new individual (client profile)

client.individuals.create(IndividualCreateParams { first_name, household_id, last_name, 16 more } body, RequestOptionsoptions?): Individual { id, created_at, first_name, 21 more }

post/individuals

Delete an individual

client.individuals.delete(stringid, RequestOptionsoptions?): void

delete/individuals/{id}

Get an individual by ID

client.individuals.retrieve(stringid, RequestOptionsoptions?): Individual { id, created_at, first_name, 21 more }

get/individuals/{id}

Update an individual

client.individuals.update(stringid, IndividualUpdateParams { address_line1, address_line2, city, 16 more } body, RequestOptionsoptions?): Individual { id, created_at, first_name, 21 more }

put/individuals/{id}

ModelsExpand Collapse

Individual { id, created_at, first_name, 21 more }

id: string

Unique identifier with client_profile_ prefix

created_at: string

Timestamp when the individual was created

formatdate-time

first_name: string

First name of the individual

household_id: string

Household ID this individual belongs to

is_beneficiary: boolean

Whether this client profile should be an eligible beneficiary for entities and gifts

is_deceased: boolean

Whether this client profile is deceased

is_grantor: boolean

Whether this client profile should be an eligible grantor/owner/other principal for entities

is_primary: boolean

Whether this is one of the (at most) two primary clients on this household

is_trustee: boolean

Whether this client profile should be an eligible trustee for entities

last_name: string

Last name of the individual

updated_at: string

Timestamp when the individual was last updated

formatdate-time

address_line1?: string | null

Street address line 1 (from address edge)

address_line2?: string | null

Street address line 2 (from address edge)

city?: string | null

City (from address edge)

country?: string | null

Country (from address edge)

date_of_birth?: string | null

Date of birth (encrypted field)

formatdate

date_of_death?: string | null

Date of death if applicable (encrypted field)

formatdate

deleted_at?: string | null

Timestamp when the individual was soft deleted

formatdate-time

email?: string | null

Email address

formatemail

middle_name?: string | null

Middle name of the individual

notes?: string | null

Notes about the client profile

maxLength65536

postal_code?: string | null

ZIP or postal code (from address edge)

state?: string | null

State or province (from address edge)

suffix?: string | null

Name suffix (Jr., Sr., III, etc.)