---
title: "List Dimensions"
method: POST
path: "/v1/dimensions/list"
tags: ["Dimension"]
---

# List Dimensions

`POST /v1/dimensions/list`

Retrieve the ids of dimensions matching the filtering criteria

## Request body

- DimensionListRequest
  - `list_context` ListContext
    - `batch_size` integer — Max number of ids in the response
    - `batch_offset` integer — Offset of batches into the results. First batch is 0
    - `total` integer — Total number of results
  - `sort` DimensionSortCriteria[] — Sort criteria
    - `column` 'Name' | 'createdOn', required
    - `ascending` boolean
  - `filters` DimensionDefinitionFilter
    - `text_filter` string — Text filter used to search names
    - `query` QueryOperator
      - `__type` string, required — Concrete type used for polymorphic deserialization (discriminator)

## Response `200`

Listed successfully

- ListResponse
  - `results` string[] — List of result identifiers
  - `next_list_context` ListContext
    - `batch_size` integer — Max number of ids in the response
    - `batch_offset` integer — Offset of batches into the results. First batch is 0
    - `total` integer — Total number of results

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/corestack/apis/corestack-external-api.md) · [All operations](https://skmtc.dev/corestack/apis/corestack-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/corestack/corestack-external-api/revisions/bf2cdf20826d/schema)
