List all households

client.Households.List(ctx, query) (*CursorPagination[Household], error)

get/households

Retrieve a paginated list of households using cursor-based pagination

ParametersExpand Collapse

query HouseholdListParams

After param.Field[string]optional

Cursor for forward pagination. Returns items after this cursor.

Before param.Field[string]optional

Cursor for backward pagination. Returns items before this cursor.

Limit param.Field[int64]optional

Maximum number of items to return

maximum1000

minimum1

ReturnsExpand Collapse

type Household struct{…}

ID string

Unique identifier with household_ prefix

CreatedAt Time

Timestamp when the household was created

formatdate-time

PrimaryRelationshipOwnerID string

User ID of the primary relationship owner

UpdatedAt Time

Timestamp when the household was last updated

formatdate-time

Name stringoptional

Display name for the household

Notes stringoptional

Notes about the household

maxLength65536

PrimaryIndividuals []Individualoptional

Primary client profiles for this household (at most 2)

ID string

Unique identifier with client_profile_ prefix

CreatedAt Time

Timestamp when the individual was created

formatdate-time

FirstName string

First name of the individual

HouseholdID string

Household ID this individual belongs to

IsBeneficiary bool

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

IsDeceased bool

Whether this client profile is deceased

IsGrantor bool

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

IsPrimary bool

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

IsTrustee bool

Whether this client profile should be an eligible trustee for entities

LastName string

Last name of the individual

UpdatedAt Time

Timestamp when the individual was last updated

formatdate-time

AddressLine1 stringoptional

Street address line 1 (from address edge)

AddressLine2 stringoptional

Street address line 2 (from address edge)

City stringoptional

City (from address edge)

Country stringoptional

Country (from address edge)

DateOfBirth Timeoptional

Date of birth (encrypted field)

formatdate

DateOfDeath Timeoptional

Date of death if applicable (encrypted field)

formatdate

DeletedAt Timeoptional

Timestamp when the individual was soft deleted

formatdate-time

Email stringoptional

Email address

formatemail

MiddleName stringoptional

Middle name of the individual

Notes stringoptional

Notes about the client profile

maxLength65536

PostalCode stringoptional

ZIP or postal code (from address edge)

State stringoptional

State or province (from address edge)

Suffix stringoptional

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

List all households

package main

import (
  "context"
  "fmt"

  "github.com/withluminary/go-sdk"
  "github.com/withluminary/go-sdk/option"
)

func main() {
  client := withluminary.NewClient(
    option.WithClientID("My Client ID"),
    option.WithClientSecret("My Client Secret"),
  )
  page, err := client.Households.List(context.TODO(), withluminary.HouseholdListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "data": [
    {
      "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "updated_at": "2024-01-20T14:45:00Z",
      "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
}

Returns Examples

{
  "data": [
    {
      "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "updated_at": "2024-01-20T14:45:00Z",
      "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
}