Skip to content
Luminary Luminary Luminary
Get started
API Reference

Households

List all households
client.households.list(HouseholdListParams { limit, offset } query?, RequestOptionsoptions?): HouseholdListResponse { data, pagination }
get/households
Create a new household
client.households.create(HouseholdCreateParams { primary_relationship_owner_id, notes, primary_individuals } body, RequestOptionsoptions?): Household { id, created_at, primary_relationship_owner_id, 4 more }
post/households
Delete a household
client.households.delete(stringid, RequestOptionsoptions?): void
delete/households/{id}
Get a household by ID
client.households.retrieve(stringid, RequestOptionsoptions?): Household { id, created_at, primary_relationship_owner_id, 4 more }
get/households/{id}
Update a household
client.households.update(stringid, HouseholdUpdateParams { notes, primary_relationship_owner_id } body, RequestOptionsoptions?): Household { id, created_at, primary_relationship_owner_id, 4 more }
put/households/{id}
List all documents in a household
client.households.listDocuments(stringid, HouseholdListDocumentsParams { limit, offset, type } query?, RequestOptionsoptions?): DocumentList { data, pagination }
get/households/{id}/documents
List all entities in a household
client.households.listEntities(stringid, HouseholdListEntitiesParams { kind, limit, offset } query?, RequestOptionsoptions?): EntityList { data, pagination }
get/households/{id}/entities
List all individuals in a household
client.households.listIndividuals(stringid, HouseholdListIndividualsParams { is_primary, limit, offset } query?, RequestOptionsoptions?): IndividualList { data, pagination }
get/households/{id}/individuals
ModelsExpand Collapse
Household { id, created_at, primary_relationship_owner_id, 4 more }
id: string

Unique identifier with household_ prefix

created_at: string

Timestamp when the household was created

formatdate-time
primary_relationship_owner_id: string

User ID of the primary relationship owner

updated_at: string

Timestamp when the household was last updated

formatdate-time
name?: string

Display name for the household

notes?: string | null

Notes about the household

maxLength65536
primary_individuals?: Array<Individual { id, created_at, first_name, 21 more } >

Primary client profiles for this household (at most 2)

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.)

IndividualList { data, pagination }
data: Array<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.)