# Households ## List all households `client.households.list(HouseholdListParamsquery?, RequestOptionsoptions?): CursorPagination` **get** `/households` Retrieve a paginated list of households using cursor-based pagination ### Parameters - `query: HouseholdListParams` - `after?: string` Cursor for forward pagination. Returns items after this cursor. - `before?: string` Cursor for backward pagination. Returns items before this cursor. - `external_id?: string` Filter by external ID (exact match within the caller's tenant) - `limit?: number` Maximum number of items to return ### Returns - `Household` - `id: string` Unique identifier with household_ prefix - `created_at: string` Timestamp when the household was created - `primary_relationship_owner_id: string` User ID of the primary relationship owner - `updated_at: string` Timestamp when the household was last updated - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. - `name?: string` Display name for the household - `notes?: string | null` Notes about the household - `primary_individuals?: Array` 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 - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); // Automatically fetches more pages as needed. for await (const household of client.households.list()) { console.log(household.id); } ``` #### Response ```json { "data": [ { "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV", "updated_at": "2024-01-20T14:45:00Z", "external_id": "crm-household-12345", "name": "Smith Family", "notes": "notes", "primary_individuals": [ { "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "first_name": "John", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "is_beneficiary": true, "is_deceased": true, "is_grantor": true, "is_primary": true, "is_trustee": true, "last_name": "Smith", "updated_at": "2024-01-20T14:45:00Z", "address_line1": "123 Main St", "address_line2": "Apt 4B", "city": "San Francisco", "country": "USA", "date_of_birth": "1980-05-15", "date_of_death": "2019-12-27", "deleted_at": "2019-12-27T18:11:19.117Z", "email": "john.smith@example.com", "middle_name": "Michael", "notes": "notes", "postal_code": "94102", "state": "CA", "suffix": "Jr." } ] } ], "page_info": { "has_next_page": true, "has_previous_page": false, "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9", "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9" }, "total_count": 100 } ``` ## Create a new household `client.households.create(HouseholdCreateParamsbody, RequestOptionsoptions?): Household` **post** `/households` Create a new household with the provided data ### Parameters - `body: HouseholdCreateParams` - `primary_relationship_owner_id: string` User ID of the primary relationship owner - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. - `notes?: string | null` Optional notes about the household - `primary_individuals?: Array` Primary client profiles to create for this household (at most 2) - `first_name: string` First name of the individual - `last_name: string` Last name of the individual - `state: string` State or province code (2 letter code) - `address_line1?: string | null` Street address line 1 - `address_line2?: string | null` Street address line 2 - `city?: string | null` City - `country?: string | null` Country - `date_of_birth?: string | null` Date of birth - `email?: string | null` Email address - `is_beneficiary?: boolean` Whether this client profile should be an eligible beneficiary for entities and gifts - `is_deceased?: boolean` Whether the individual is deceased - `is_trustee?: boolean` Whether this client profile should be an eligible trustee for entities - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `postal_code?: string | null` ZIP or postal code - `suffix?: string | null` Name suffix ### Returns - `Household` - `id: string` Unique identifier with household_ prefix - `created_at: string` Timestamp when the household was created - `primary_relationship_owner_id: string` User ID of the primary relationship owner - `updated_at: string` Timestamp when the household was last updated - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. - `name?: string` Display name for the household - `notes?: string | null` Notes about the household - `primary_individuals?: Array` 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 - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); const household = await client.households.create({ primary_relationship_owner_id: 'user_01ARZ3NDEKTSV4RRFFQ69G5FAV', }); console.log(household.id); ``` #### Response ```json { "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV", "updated_at": "2024-01-20T14:45:00Z", "external_id": "crm-household-12345", "name": "Smith Family", "notes": "notes", "primary_individuals": [ { "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "first_name": "John", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "is_beneficiary": true, "is_deceased": true, "is_grantor": true, "is_primary": true, "is_trustee": true, "last_name": "Smith", "updated_at": "2024-01-20T14:45:00Z", "address_line1": "123 Main St", "address_line2": "Apt 4B", "city": "San Francisco", "country": "USA", "date_of_birth": "1980-05-15", "date_of_death": "2019-12-27", "deleted_at": "2019-12-27T18:11:19.117Z", "email": "john.smith@example.com", "middle_name": "Michael", "notes": "notes", "postal_code": "94102", "state": "CA", "suffix": "Jr." } ] } ``` ## Delete a household `client.households.delete(stringid, RequestOptionsoptions?): void` **delete** `/households/{id}` Soft delete a household (marks as deleted but preserves data) ### Parameters - `id: string` ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); await client.households.delete('id'); ``` ## Get a household by ID `client.households.retrieve(stringid, RequestOptionsoptions?): Household` **get** `/households/{id}` Retrieve detailed information about a specific household ### Parameters - `id: string` ### Returns - `Household` - `id: string` Unique identifier with household_ prefix - `created_at: string` Timestamp when the household was created - `primary_relationship_owner_id: string` User ID of the primary relationship owner - `updated_at: string` Timestamp when the household was last updated - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. - `name?: string` Display name for the household - `notes?: string | null` Notes about the household - `primary_individuals?: Array` 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 - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); const household = await client.households.retrieve('id'); console.log(household.id); ``` #### Response ```json { "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV", "updated_at": "2024-01-20T14:45:00Z", "external_id": "crm-household-12345", "name": "Smith Family", "notes": "notes", "primary_individuals": [ { "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "first_name": "John", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "is_beneficiary": true, "is_deceased": true, "is_grantor": true, "is_primary": true, "is_trustee": true, "last_name": "Smith", "updated_at": "2024-01-20T14:45:00Z", "address_line1": "123 Main St", "address_line2": "Apt 4B", "city": "San Francisco", "country": "USA", "date_of_birth": "1980-05-15", "date_of_death": "2019-12-27", "deleted_at": "2019-12-27T18:11:19.117Z", "email": "john.smith@example.com", "middle_name": "Michael", "notes": "notes", "postal_code": "94102", "state": "CA", "suffix": "Jr." } ] } ``` ## Update a household `client.households.update(stringid, HouseholdUpdateParamsbody, RequestOptionsoptions?): Household` **put** `/households/{id}` Update an existing household with new data ### Parameters - `id: string` - `body: HouseholdUpdateParams` - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. Send null to clear. - `notes?: string | null` Notes about the household - `primary_relationship_owner_id?: string` User ID of the primary relationship owner ### Returns - `Household` - `id: string` Unique identifier with household_ prefix - `created_at: string` Timestamp when the household was created - `primary_relationship_owner_id: string` User ID of the primary relationship owner - `updated_at: string` Timestamp when the household was last updated - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. - `name?: string` Display name for the household - `notes?: string | null` Notes about the household - `primary_individuals?: Array` 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 - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); const household = await client.households.update('id'); console.log(household.id); ``` #### Response ```json { "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV", "updated_at": "2024-01-20T14:45:00Z", "external_id": "crm-household-12345", "name": "Smith Family", "notes": "notes", "primary_individuals": [ { "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "first_name": "John", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "is_beneficiary": true, "is_deceased": true, "is_grantor": true, "is_primary": true, "is_trustee": true, "last_name": "Smith", "updated_at": "2024-01-20T14:45:00Z", "address_line1": "123 Main St", "address_line2": "Apt 4B", "city": "San Francisco", "country": "USA", "date_of_birth": "1980-05-15", "date_of_death": "2019-12-27", "deleted_at": "2019-12-27T18:11:19.117Z", "email": "john.smith@example.com", "middle_name": "Michael", "notes": "notes", "postal_code": "94102", "state": "CA", "suffix": "Jr." } ] } ``` ## List all documents in a household `client.households.listDocuments(stringid, HouseholdListDocumentsParamsquery?, RequestOptionsoptions?): CursorPagination` **get** `/households/{id}/documents` Retrieve a paginated list of documents belonging to a specific household ### Parameters - `id: string` - `query: HouseholdListDocumentsParams` - `after?: string` Cursor for forward pagination. Returns items after this cursor. - `before?: string` Cursor for backward pagination. Returns items before this cursor. - `limit?: number` Maximum number of items to return - `type?: DocumentType` Filter by document type - `"GRAT_DESIGN_SUMMARY"` - `"GENERATED_PRESENTATION"` - `"ASSET_VALUATION"` - `"SIGNED_TRUST_DOCUMENT"` - `"TRUST_AMENDMENT"` - `"TRANSFER_CONFIRMATION"` - `"EXISTING_REMAINDER_TRUST_DOCUMENT"` - `"BALANCE_SHEET"` - `"WILL"` - `"WILL_CODICIL"` - `"POWER_OF_ATTORNEY"` - `"ASSIGNMENT_OF_INTEREST"` - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"` - `"LOAN_NOTE_AGREEMENT"` - `"ARTICLES_OF_INCORPORATION"` - `"OPERATING_AGREEMENT"` - `"PARTNERSHIP_AGREEMENT"` - `"ACCOUNT_DOCUMENTATION_STATEMENT"` - `"TAX_ID_CONFIRMATION"` - `"GIFT_TAX_RETURN"` - `"INCOME_TAX_RETURN"` - `"TAX_RECEIPT"` - `"TAX_FILING"` - `"CORPORATE_BYLAWS"` - `"LLC_AGREEMENT"` - `"LLC_AGREEMENT_AMENDMENT"` - `"OPERATING_AGREEMENT_AMENDMENT"` - `"PARTNERSHIP_AGREEMENT_AMENDMENT"` - `"SHAREHOLDERS_AGREEMENT"` - `"STATE_BUSINESS_FILING"` - `"LOGGED_CONTRIBUTION"` - `"LOGGED_DISTRIBUTION"` - `"INSURANCE_POLICY"` - `"CRUMMEY_LETTER"` - `"INSURANCE_PREMIUM_PAYMENT"` - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"` - `"FINCEN_FILING"` - `"HEALTHCARE_PROXY"` - `"LIVING_WILL"` - `"DRIVERS_LICENSE"` - `"PASSPORT"` - `"DEED"` - `"OTHER"` ### Returns - `Document` - `id: string` Unique identifier with document_ prefix - `created_at: string` Timestamp when the document was created - `household_id: string` Household ID this document belongs to - `name: string` Display name of the document - `type: DocumentType` Type of document - `"GRAT_DESIGN_SUMMARY"` - `"GENERATED_PRESENTATION"` - `"ASSET_VALUATION"` - `"SIGNED_TRUST_DOCUMENT"` - `"TRUST_AMENDMENT"` - `"TRANSFER_CONFIRMATION"` - `"EXISTING_REMAINDER_TRUST_DOCUMENT"` - `"BALANCE_SHEET"` - `"WILL"` - `"WILL_CODICIL"` - `"POWER_OF_ATTORNEY"` - `"ASSIGNMENT_OF_INTEREST"` - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"` - `"LOAN_NOTE_AGREEMENT"` - `"ARTICLES_OF_INCORPORATION"` - `"OPERATING_AGREEMENT"` - `"PARTNERSHIP_AGREEMENT"` - `"ACCOUNT_DOCUMENTATION_STATEMENT"` - `"TAX_ID_CONFIRMATION"` - `"GIFT_TAX_RETURN"` - `"INCOME_TAX_RETURN"` - `"TAX_RECEIPT"` - `"TAX_FILING"` - `"CORPORATE_BYLAWS"` - `"LLC_AGREEMENT"` - `"LLC_AGREEMENT_AMENDMENT"` - `"OPERATING_AGREEMENT_AMENDMENT"` - `"PARTNERSHIP_AGREEMENT_AMENDMENT"` - `"SHAREHOLDERS_AGREEMENT"` - `"STATE_BUSINESS_FILING"` - `"LOGGED_CONTRIBUTION"` - `"LOGGED_DISTRIBUTION"` - `"INSURANCE_POLICY"` - `"CRUMMEY_LETTER"` - `"INSURANCE_PREMIUM_PAYMENT"` - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"` - `"FINCEN_FILING"` - `"HEALTHCARE_PROXY"` - `"LIVING_WILL"` - `"DRIVERS_LICENSE"` - `"PASSPORT"` - `"DEED"` - `"OTHER"` - `updated_at: string` Timestamp when the document was last updated - `enable_ai_suggestions?: boolean` Whether this document should be used for AI suggestions - `entity_id?: string | null` Entity ID if this document is owned by an entity - `individual_id?: string | null` Individual ID if this document is associated with an individual ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); // Automatically fetches more pages as needed. for await (const document of client.households.listDocuments('id')) { console.log(document.id); } ``` #### Response ```json { "data": [ { "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "name": "Trust Agreement.pdf", "type": "GRAT_DESIGN_SUMMARY", "updated_at": "2024-01-20T14:45:00Z", "enable_ai_suggestions": true, "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV", "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV" } ], "page_info": { "has_next_page": true, "has_previous_page": false, "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9", "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9" }, "total_count": 100 } ``` ## List all entities in a household `client.households.listEntities(stringid, HouseholdListEntitiesParamsquery?, RequestOptionsoptions?): CursorPagination` **get** `/households/{id}/entities` Retrieve a paginated list of entities belonging to a specific household ### Parameters - `id: string` - `query: HouseholdListEntitiesParams` - `after?: string` Cursor for forward pagination. Returns items after this cursor. - `before?: string` Cursor for backward pagination. Returns items before this cursor. - `kind?: EntityKind` Filter by entity kind/type - `"REVOCABLE_TRUST"` - `"IRREVOCABLE_TRUST"` - `"SLAT_TRUST"` - `"ILIT_TRUST"` - `"QPRT_TRUST"` - `"GRAT_TRUST"` - `"CRT_TRUST"` - `"CLT_TRUST"` - `"INDIVIDUAL_PERSONAL_ACCOUNT"` - `"JOINT_PERSONAL_ACCOUNT"` - `"CUSTODIAL_PERSONAL_ACCOUNT"` - `"INSURANCE_PERSONAL_ACCOUNT"` - `"QUALIFIED_TUITION_PERSONAL_ACCOUNT"` - `"RETIREMENT_PERSONAL_ACCOUNT"` - `"DONOR_ADVISED_FUND"` - `"PRIVATE_FOUNDATION"` - `"LLC_BUSINESS_ENTITY"` - `"LP_BUSINESS_ENTITY"` - `"GP_BUSINESS_ENTITY"` - `"SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"` - `"SCORP_BUSINESS_ENTITY"` - `"CCORP_BUSINESS_ENTITY"` - `limit?: number` Maximum number of items to return ### Returns - `Entity` - `id: string` Unique identifier with entity_ prefix - `created_at: string` Timestamp when the entity was created - `display_name: string` Display name of the entity - `household_id: string` Household ID this entity belongs to - `in_estate_status: "in_estate" | "out_of_estate" | "none"` Whether the entity is in or out of the estate - `"in_estate"` - `"out_of_estate"` - `"none"` - `kind: EntityKind` Type of entity - determines the specific subtype and applicable fields - `"REVOCABLE_TRUST"` - `"IRREVOCABLE_TRUST"` - `"SLAT_TRUST"` - `"ILIT_TRUST"` - `"QPRT_TRUST"` - `"GRAT_TRUST"` - `"CRT_TRUST"` - `"CLT_TRUST"` - `"INDIVIDUAL_PERSONAL_ACCOUNT"` - `"JOINT_PERSONAL_ACCOUNT"` - `"CUSTODIAL_PERSONAL_ACCOUNT"` - `"INSURANCE_PERSONAL_ACCOUNT"` - `"QUALIFIED_TUITION_PERSONAL_ACCOUNT"` - `"RETIREMENT_PERSONAL_ACCOUNT"` - `"DONOR_ADVISED_FUND"` - `"PRIVATE_FOUNDATION"` - `"LLC_BUSINESS_ENTITY"` - `"LP_BUSINESS_ENTITY"` - `"GP_BUSINESS_ENTITY"` - `"SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"` - `"SCORP_BUSINESS_ENTITY"` - `"CCORP_BUSINESS_ENTITY"` - `stage: "PRE_CREATED" | "AI_CREATING" | "AI_CREATION_FAILED" | 7 more` Lifecycle stage of the entity - `"PRE_CREATED"` - `"AI_CREATING"` - `"AI_CREATION_FAILED"` - `"AI_NEEDS_REVIEW"` - `"DRAFT"` - `"READY_FOR_PROPOSAL"` - `"IMPLEMENTATION"` - `"ACTIVE"` - `"COMPLETED"` - `"ARCHIVED"` - `updated_at: string` Timestamp when the entity was last updated - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); // Automatically fetches more pages as needed. for await (const entity of client.households.listEntities('id')) { console.log(entity.id); } ``` #### Response ```json { "data": [ { "id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "display_name": "My Revocable Trust", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "in_estate_status": "in_estate", "kind": "REVOCABLE_TRUST", "stage": "PRE_CREATED", "updated_at": "2024-01-20T14:45:00Z", "external_id": "crm-entity-12345" } ], "page_info": { "has_next_page": true, "has_previous_page": false, "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9", "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9" }, "total_count": 100 } ``` ## List all individuals in a household `client.households.listIndividuals(stringid, HouseholdListIndividualsParamsquery?, RequestOptionsoptions?): CursorPagination` **get** `/households/{id}/individuals` Retrieve a paginated list of client profiles/individuals belonging to a specific household ### Parameters - `id: string` - `query: HouseholdListIndividualsParams` - `after?: string` Cursor for forward pagination. Returns items after this cursor. - `before?: string` Cursor for backward pagination. Returns items before this cursor. - `is_primary?: boolean` Filter by primary client status - `limit?: number` Maximum number of items to return ### Returns - `Individual` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); // Automatically fetches more pages as needed. for await (const individual of client.households.listIndividuals('id')) { console.log(individual.id); } ``` #### Response ```json { "data": [ { "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV", "created_at": "2024-01-15T09:30:00Z", "first_name": "John", "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV", "is_beneficiary": true, "is_deceased": true, "is_grantor": true, "is_primary": true, "is_trustee": true, "last_name": "Smith", "updated_at": "2024-01-20T14:45:00Z", "address_line1": "123 Main St", "address_line2": "Apt 4B", "city": "San Francisco", "country": "USA", "date_of_birth": "1980-05-15", "date_of_death": "2019-12-27", "deleted_at": "2019-12-27T18:11:19.117Z", "email": "john.smith@example.com", "middle_name": "Michael", "notes": "notes", "postal_code": "94102", "state": "CA", "suffix": "Jr." } ], "page_info": { "has_next_page": true, "has_previous_page": false, "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9", "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9" }, "total_count": 100 } ``` ## Domain Types ### Household - `Household` - `id: string` Unique identifier with household_ prefix - `created_at: string` Timestamp when the household was created - `primary_relationship_owner_id: string` User ID of the primary relationship owner - `updated_at: string` Timestamp when the household was last updated - `external_id?: string | null` Customer-supplied identifier from an external system. Unique within the caller's tenant when set. - `name?: string` Display name for the household - `notes?: string | null` Notes about the household - `primary_individuals?: Array` 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 - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Individual List - `IndividualList` - `data: Array` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) - `page_info: PageInfo` - `has_next_page: boolean` When paginating forwards, are there more items? - `has_previous_page: boolean` When paginating backwards, are there more items? - `end_cursor?: string | null` Cursor pointing to the last item in the current page - `start_cursor?: string | null` Cursor pointing to the first item in the current page - `total_count: number` Total number of items matching the query (across all pages)