# Index taxonomy

> Return the Deal Index taxonomy tree for a deal. Use a node's id as the portal ?node= only for selectable rows. Prefer sidebar_node_id on Search Index hits; use this tree only when you need to walk it.

Source: https://www.lev.com/docs/build/index/taxonomy

Last updated: 2026-10-19

---
### `GET /api/external/v2/deals/{deal_id}/index/taxonomy`

Return the Deal Index navtree used to resolve citation ?node= values

#### Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `deal_id` | `integer` | Yes | The deal ID |

#### Query Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `include` | `string[]` | No | Optional repeatable node-type filter: CATEGORY, SUB_CATEGORY, METRIC_GROUP, or ENTITY_GROUP. Omit or empty returns the full tree. Serialized as repeated query keys (?include=SUB_CATEGORY&include=ENTITY_GROUP). This is a taxonomy type filter, not deal ?include=financials. |

Response: `200`

#### Error Responses

- **401** (unauthorized): Authentication required
- **403** (forbidden): Missing required scope: deals:read
- **404** (not_found): Deal not found
- **503** (service_unavailable): Deal taxonomy is temporarily unavailable. Try again shortly.