## List all entities

**get** `/entities`

Retrieve a paginated list of entities (trusts, businesses, accounts, etc.) using cursor-based pagination

### Query Parameters

- `after: optional string`

  Cursor for forward pagination. Returns items after this cursor.

- `before: optional string`

  Cursor for backward pagination. Returns items before this cursor.

- `external_id: optional string`

  Filter by external ID (exact match within the caller's tenant)

- `household_id: optional string`

  Filter entities by household ID

- `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 number`

  Maximum number of items to return

### Returns

- `EntityList object { data, page_info, total_count }`

  - `data: array of 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" or "out_of_estate" or "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" or "AI_CREATING" or "AI_CREATION_FAILED" or 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: optional string`

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

  - `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: optional string`

      Cursor pointing to the last item in the current page

    - `start_cursor: optional string`

      Cursor pointing to the first item in the current page

  - `total_count: number`

    Total number of items matching the query (across all pages)

### Example

```http
curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/entities
```

#### 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
}
```