Skip to content
Luminary Luminary Luminary
Get started
API Reference
Households

List all entities in a household

get/households/{id}/entities

Retrieve a paginated list of entities belonging to a specific household

Path ParametersExpand Collapse
id: string
Query ParametersExpand Collapse
kind: optional EntityKind

Filter by entity kind/type

Accepts one of the following:
"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: optional number

Maximum number of entities to return

maximum1000
minimum1
offset: optional number

Number of entities to skip

minimum0
ReturnsExpand Collapse
EntityList = object { data, pagination }
data: array of Entity { id, created_at, display_name, 4 more }
id: string

Unique identifier with entity_ prefix

created_at: string

Timestamp when the entity was created

formatdate-time
display_name: string

Display name of the entity

household_id: string

Household ID this entity belongs to

kind: EntityKind

Type of entity - determines the specific subtype and applicable fields

Accepts one of the following:
"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" or "AI_CREATING" or "AI_CREATION_FAILED" or 7 more

Lifecycle stage of the entity

Accepts one of the following:
"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

formatdate-time
List all entities in a household
curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/households/$ID/entities
{
  "data": [
    {
      "id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "display_name": "My Revocable Trust",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "kind": "REVOCABLE_TRUST",
      "stage": "PRE_CREATED",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 150
  }
}
Returns Examples
{
  "data": [
    {
      "id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "display_name": "My Revocable Trust",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "kind": "REVOCABLE_TRUST",
      "stage": "PRE_CREATED",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 150
  }
}