List all entities in a household

client.Households.ListEntities(ctx, id, query) (*CursorPagination[Entity], error)

get/households/{id}/entities

Retrieve a paginated list of entities belonging to a specific household

ParametersExpand Collapse

id string

query HouseholdListEntitiesParams

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.

Kind param.Field[EntityKind]optional

Filter by entity kind/type

Limit param.Field[int64]optional

Maximum number of items to return

maximum1000

minimum1

ReturnsExpand Collapse

type Entity struct{…}

ID string

Unique identifier with entity_ prefix

CreatedAt Time

Timestamp when the entity was created

formatdate-time

DisplayName string

Display name of the entity

HouseholdID string

Household ID this entity belongs to

InEstateStatus EntityInEstateStatus

Whether the entity is in or out of the estate

Accepts one of the following:

const EntityInEstateStatusInEstate EntityInEstateStatus = "in_estate"

const EntityInEstateStatusOutOfEstate EntityInEstateStatus = "out_of_estate"

const EntityInEstateStatusNone EntityInEstateStatus = "none"

Kind EntityKind

Type of entity - determines the specific subtype and applicable fields

Accepts one of the following:

const EntityKindRevocableTrust EntityKind = "REVOCABLE_TRUST"

const EntityKindIrrevocableTrust EntityKind = "IRREVOCABLE_TRUST"

const EntityKindSlatTrust EntityKind = "SLAT_TRUST"

const EntityKindIlitTrust EntityKind = "ILIT_TRUST"

const EntityKindQprtTrust EntityKind = "QPRT_TRUST"

const EntityKindGratTrust EntityKind = "GRAT_TRUST"

const EntityKindCrtTrust EntityKind = "CRT_TRUST"

const EntityKindCltTrust EntityKind = "CLT_TRUST"

const EntityKindIndividualPersonalAccount EntityKind = "INDIVIDUAL_PERSONAL_ACCOUNT"

const EntityKindJointPersonalAccount EntityKind = "JOINT_PERSONAL_ACCOUNT"

const EntityKindCustodialPersonalAccount EntityKind = "CUSTODIAL_PERSONAL_ACCOUNT"

const EntityKindInsurancePersonalAccount EntityKind = "INSURANCE_PERSONAL_ACCOUNT"

const EntityKindQualifiedTuitionPersonalAccount EntityKind = "QUALIFIED_TUITION_PERSONAL_ACCOUNT"

const EntityKindRetirementPersonalAccount EntityKind = "RETIREMENT_PERSONAL_ACCOUNT"

const EntityKindDonorAdvisedFund EntityKind = "DONOR_ADVISED_FUND"

const EntityKindPrivateFoundation EntityKind = "PRIVATE_FOUNDATION"

const EntityKindLlcBusinessEntity EntityKind = "LLC_BUSINESS_ENTITY"

const EntityKindLpBusinessEntity EntityKind = "LP_BUSINESS_ENTITY"

const EntityKindGpBusinessEntity EntityKind = "GP_BUSINESS_ENTITY"

const EntityKindSoleProprietorshipBusinessEntity EntityKind = "SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"

const EntityKindScorpBusinessEntity EntityKind = "SCORP_BUSINESS_ENTITY"

const EntityKindCcorpBusinessEntity EntityKind = "CCORP_BUSINESS_ENTITY"

Stage EntityStage

Lifecycle stage of the entity

Accepts one of the following:

const EntityStagePreCreated EntityStage = "PRE_CREATED"

const EntityStageAICreating EntityStage = "AI_CREATING"

const EntityStageAICreationFailed EntityStage = "AI_CREATION_FAILED"

const EntityStageAINeedsReview EntityStage = "AI_NEEDS_REVIEW"

const EntityStageDraft EntityStage = "DRAFT"

const EntityStageReadyForProposal EntityStage = "READY_FOR_PROPOSAL"

const EntityStageImplementation EntityStage = "IMPLEMENTATION"

const EntityStageActive EntityStage = "ACTIVE"

const EntityStageCompleted EntityStage = "COMPLETED"

const EntityStageArchived EntityStage = "ARCHIVED"

UpdatedAt Time

Timestamp when the entity was last updated

formatdate-time

List all entities in a household

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.ListEntities(
    context.TODO(),
    "id",
    withluminary.HouseholdListEntitiesParams{

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

{
  "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"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}

Returns Examples

{
  "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"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}