## List all entities in a household

`households.list_entities(strid, HouseholdListEntitiesParams**kwargs)  -> SyncCursorPagination[Entity]`

**get** `/households/{id}/entities`

Retrieve a paginated list of entities belonging to a specific household

### Parameters

- `id: str`

- `after: Optional[str]`

  Cursor for forward pagination. Returns items after this cursor.

- `before: Optional[str]`

  Cursor for backward pagination. Returns items before this cursor.

- `kind: Optional[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: Optional[int]`

  Maximum number of items to return

### Returns

- `class Entity: …`

  - `id: str`

    Unique identifier with entity_ prefix

  - `created_at: datetime`

    Timestamp when the entity was created

  - `display_name: str`

    Display name of the entity

  - `household_id: str`

    Household ID this entity belongs to

  - `in_estate_status: Literal["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: Literal["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: datetime`

    Timestamp when the entity was last updated

  - `external_id: Optional[str]`

    Customer-supplied identifier from an external system. Unique within the caller's tenant when set.

### Example

```python
from withluminary import Luminary

client = Luminary()
page = client.households.list_entities(
    id="id",
)
page = page.data[0]
print(page.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
}
```