---
title: "List Deal Index Taxonomy"
method: GET
path: "/api/external/v2/deals/{deal_id}/index/taxonomy"
tags: ["external-v2-deals"]
---

# List Deal Index Taxonomy

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

## Request

- Base URL: `https://api.lev.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.lev.com/api/external/v2/deals/{deal_id}/index/taxonomy`
- Auth: none declared

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

Same tree as GraphQL ``metricsTaxonomy``. ``id`` is the portal sidebar
selection. Match ``search_deal_index`` facts via ``category_id`` and
``ref_id`` / ``entity_ref``. Do not invent a node when no row matches.
The full tree is returned; query ``include`` filters node types only.

## Path parameters

- `deal_id` integer, required

## Query parameters

- `include` TaxonomyNodeType[], nullable: Optional TaxonomyNodeType filter: CATEGORY, SUB_CATEGORY, METRIC_GROUP, ENTITY_GROUP. Repeatable. Omit or empty returns the full tree.

## Response `200`

Successful Response

- DealIndexTaxonomyListResponse: OpenAPI schema for GET /api/external/v2/deals/<id>/index/taxonomy.
  - `request_id` string, required
  - `timestamp` string, required
  - `data` DealIndexTaxonomyNodeResponse[], required
    - `id` string, nullable
    - `parent_id` string, nullable
    - `type` string, nullable
    - `label` string, nullable
    - `value` string, nullable
    - `order` integer, nullable
    - `icon` string, nullable
    - `category_id` integer, nullable
    - `dashboard_type` string, nullable
    - `ref_id` string, nullable
  - `pagination` unknown, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-25** `04c60da269dc`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lev/apis/lev-api/changes/api/external/v2/deals/:deal_id/index/taxonomy/get.md)

---

[API](https://skmtc.dev/lev/apis/lev-api.md) - [All operations](https://skmtc.dev/lev/apis/lev-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lev/apis/lev-api/revisions/6330d0ef0603?raw)