---
title: "Get a list of dimensions for an instance"
method: GET
path: "/instances/{instance_id}/dimensions"
tags: ["Private"]
---

# Get a list of dimensions for an instance

`GET /instances/{instance_id}/dimensions`

## Request

- Base URL: `https://api.beta.ons.gov.uk/v1`
- URL: `https://api.beta.ons.gov.uk/v1/instances/{instance_id}/dimensions`
- Auth: API key in header `Authorization`

Get all dimensions from an instance

## Path parameters

- `instance_id` string, required

## Headers

- `If-Match` string

## Response `200`

Return a list of dimensions

- DimensionOption[]
  - `dimension` string: The name of the dimension
  - `instance_id` string: The unique identifier for the instance in which this dimension option is associated to
  - `label` string: A label given to a dimension option
  - `links` object: A object with all resources related to a dimension option
    - `code` object: A link to the code of the dimension for this option
      - `href` string: The url of the code that refers to the dimension for this option
      - `id` string: The id of the code that refers to the dimension for this option
    - `code_list` object: A link to the code list the dimension for this option belongs to
      - `href` string: The url of the code list that the dimension for this option belongs to
      - `id` string: The id of the code list that the dimension for this option belongs to
    - `version` object: A link to the version of the dataset the option belongs to
      - `href` string: The href of the version that this option belongs to
      - `id` string: The id of the version that this option belongs to
  - `node_id` string: The id of the node
  - `option` string: An option for a dimension

## Other responses

- `400`: Failed to process the request due to invalid request
- `401`: The token provided is unauthorised to carry out this operation
- `403`: The request is forbidden
- `404`: The instance was not found
- `409`: Failed to process the request due to a conflict
- `500`: Failed to process the request due to an internal error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/dataset-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/dataset-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/dataset-api/revisions/a2947a13d675?raw)