API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Households

List all households

households.list(HouseholdListParams**kwargs) -> SyncCursorPagination[Household]

get/households

Create a new household

households.create(HouseholdCreateParams**kwargs) -> Household

post/households

Delete a household

households.delete(strid)

delete/households/{id}

Get a household by ID

households.retrieve(strid) -> Household

get/households/{id}

Update a household

households.update(strid, HouseholdUpdateParams**kwargs) -> Household

put/households/{id}

List all documents in a household

households.list_documents(strid, HouseholdListDocumentsParams**kwargs) -> SyncCursorPagination[Document]

get/households/{id}/documents

List all entities in a household

households.list_entities(strid, HouseholdListEntitiesParams**kwargs) -> SyncCursorPagination[Entity]

get/households/{id}/entities

List all individuals in a household

households.list_individuals(strid, HouseholdListIndividualsParams**kwargs) -> SyncCursorPagination[Individual]

get/households/{id}/individuals

ModelsExpand Collapse

class Household: …

id: str

Unique identifier with household_ prefix

created_at: datetime

Timestamp when the household was created

formatdate-time

primary_relationship_owner_id: str

User ID of the primary relationship owner

updated_at: datetime

Timestamp when the household was last updated

formatdate-time

name: Optional[str]

Display name for the household

notes: Optional[str]

Notes about the household

maxLength65536

primary_individuals: Optional[List[Individual]]

Primary client profiles for this household (at most 2)

id: str

Unique identifier with client_profile_ prefix

created_at: datetime

Timestamp when the individual was created

formatdate-time

first_name: str

First name of the individual

household_id: str

Household ID this individual belongs to

is_beneficiary: bool

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

is_deceased: bool

Whether this client profile is deceased

is_grantor: bool

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

is_primary: bool

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

is_trustee: bool

Whether this client profile should be an eligible trustee for entities

last_name: str

Last name of the individual

updated_at: datetime

Timestamp when the individual was last updated

formatdate-time

address_line1: Optional[str]

Street address line 1 (from address edge)

address_line2: Optional[str]

Street address line 2 (from address edge)

city: Optional[str]

City (from address edge)

country: Optional[str]

Country (from address edge)

date_of_birth: Optional[date]

Date of birth (encrypted field)

formatdate

date_of_death: Optional[date]

Date of death if applicable (encrypted field)

formatdate

deleted_at: Optional[datetime]

Timestamp when the individual was soft deleted

formatdate-time

email: Optional[str]

Email address

formatemail

middle_name: Optional[str]

Middle name of the individual

notes: Optional[str]

Notes about the client profile

maxLength65536

postal_code: Optional[str]

ZIP or postal code (from address edge)

state: Optional[str]

State or province (from address edge)

suffix: Optional[str]

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

class IndividualList: …

data: List[Individual]

id: str

Unique identifier with client_profile_ prefix

created_at: datetime

Timestamp when the individual was created

formatdate-time

first_name: str

First name of the individual

household_id: str

Household ID this individual belongs to

is_beneficiary: bool

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

is_deceased: bool

Whether this client profile is deceased

is_grantor: bool

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

is_primary: bool

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

is_trustee: bool

Whether this client profile should be an eligible trustee for entities

last_name: str

Last name of the individual

updated_at: datetime

Timestamp when the individual was last updated

formatdate-time

address_line1: Optional[str]

Street address line 1 (from address edge)

address_line2: Optional[str]

Street address line 2 (from address edge)

city: Optional[str]

City (from address edge)

country: Optional[str]

Country (from address edge)

date_of_birth: Optional[date]

Date of birth (encrypted field)

formatdate

date_of_death: Optional[date]

Date of death if applicable (encrypted field)

formatdate

deleted_at: Optional[datetime]

Timestamp when the individual was soft deleted

formatdate-time

email: Optional[str]

Email address

formatemail

middle_name: Optional[str]

Middle name of the individual

notes: Optional[str]

Notes about the client profile

maxLength65536

postal_code: Optional[str]

ZIP or postal code (from address edge)

state: Optional[str]

State or province (from address edge)

suffix: Optional[str]

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

page_info: PageInfo

has_next_page: bool

When paginating forwards, are there more items?

has_previous_page: bool

When paginating backwards, are there more items?

end_cursor: Optional[str]

Cursor pointing to the last item in the current page

start_cursor: Optional[str]

Cursor pointing to the first item in the current page

total_count: int

Total number of items matching the query (across all pages)