Build

Index Entities

List a deal’s indexable entities and their entity_ref values in the Lev API.

Updated September 2026

GET/api/external/v2/deals/{deal_id}/index/entities

List the entities you can attach recorded facts to

Lists the deal's entities and their entity_ref values — the deal itself plus its properties, sponsor, broker, and team members. Pass an entity_ref to Insert Index Facts to target which entity a recorded value belongs to. The entity_ref must match the metric's entity type: a property metric such as in-place NOI is recorded against a property: ref, not the deal: ref.

This endpoint does not create entities. To add a new property, call Create Deal (properties) or Update Deal (add_properties) — an address is the minimum required field — then read this endpoint again for the new entity_ref.

Path parameters

deal_idintegerrequired

The deal ID

curl "https://api.lev.com/api/external/v2/deals/101/index/entities" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (200):

{
  "request_id": "a7b8c9d0-e1f2-3456-abcd-567890123456",
  "timestamp": "2026-06-01T15:13:07Z",
  "data": [
    {
      "entity_ref": "deal:101",
      "entity_type": "deal",
      "entity_id": 101,
      "group_ref": null,
      "identifying_metrics": [
        {
          "metric_key": "deal.metadata.title",
          "metric_label": "Title",
          "value_text": "2727 Cedar Springs Road, Dallas, TX",
          "support_multiple_values": false
        }
      ]
    },
    {
      "entity_ref": "property:690",
      "entity_type": "property",
      "entity_id": 690,
      "group_ref": null,
      "identifying_metrics": [
        {
          "metric_key": "properties.property_details.identification.address",
          "metric_label": "Address",
          "value_text": "2727 Cedar Springs Road, Dallas, TX",
          "support_multiple_values": true
        }
      ]
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 2,
    "offset": 0,
    "has_more": false
  }
}

401unauthorized

Authentication required— Missing or invalid Authorization header

404not_found

Deal not found— The deal_id doesn't exist or isn't accessible to the authenticated user

503service_unavailable

Deal entities are temporarily unavailable. Please try again shortly.— The entity-discovery service is unavailable