---
title: "List XBRL axes + members reported by the entity (premium)"
method: GET
path: "/api/v1/entities/{entity_id}/dimensions"
tags: ["Entities"]
---

# List XBRL axes + members reported by the entity (premium)

`GET /api/v1/entities/{entity_id}/dimensions`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/entities/{entity_id}/dimensions`
- Auth: HTTP bearer

**Discovery endpoint** — returns the dimensional structure an entity reports : which XBRL axes are used, which members per axis, and which Hub metrics carry which axis. Each axis is tagged with its `axis_kind` (geography, segment, product, equity_rollforward, debt, fv_hierarchy, concentration, ppe, awards, generic) so callers can dispatch to the right downstream call without parsing qnames themselves.

Use this BEFORE calling `/v1/entities/{id}/financials/breakdown?metric=…` to discover what metrics support what drill-downs. `metrics_using_axis` per axis tells you which `metric` values are valid for the breakdown call on that axis.

## Path parameters

- `entity_id` string, required

## Response `200`

Dimensions overview.

- ApiResponseEntityDimensionsResponse
  - `success` boolean, required
  - `data` EntityDimensionsResponse: Dimensions overview for one entity.
    - `entity_id` string, required
    - `axes` DimensionAxis[]
      - `axis_qname` string, required: Full XBRL qname of the axis, e.g. `us-gaap:StatementBusinessSegmentsAxis`.
      - `axis_label` string, required: Human-readable label (Statement prefix + Axis suffix stripped, camelCase split).
      - `axis_kind` string, required: Semantic classification: one of `geography`, `segment`, `product`, `equity_rollforward`, `debt`, `fv_hierarchy`, `concentration`, `ppe`, `awards`, or `generic`.
      - `member_count` integer, required: Distinct members observed on this axis for this entity.
      - `members` DimensionMember[]
        - `member_qname` string, required: Full XBRL qname, e.g. `msft:IntelligentCloudMember` or `country:US`.
        - `member_label` string, required: Human-readable label derived from the qname (Member suffix stripped, camelCase split). Short uppercase locals (country codes) preserved as-is.
      - `metrics_using_axis` string[]: Hub concept codes that are tagged with this axis on at least one fact. Tells SDK callers which metrics support a `/financials/breakdown?metric=…` drill on this axis.
    - `total` integer, required
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `404`: Entity not found.
- `422`: Validation Error

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)