---
title: "Get a list of options from a dimension (filterable and cantabular datasets only)"
method: GET
path: "/datasets/{id}/editions/{edition}/versions/{version}/dimensions/{dimension}/options"
tags: ["Public"]
---

# Get a list of options from a dimension (filterable and cantabular datasets only)

`GET /datasets/{id}/editions/{edition}/versions/{version}/dimensions/{dimension}/options`

## Request

- Base URL: `https://api.beta.ons.gov.uk/v1`
- URL: `https://api.beta.ons.gov.uk/v1/datasets/{id}/editions/{edition}/versions/{version}/dimensions/{dimension}/options`
- Auth: one of:
  - none
  - API key in header `Authorization`

Get a list of options which appear in this dimension and dataset. By default all options are returned, but a subset can be requested by providing offset and limit query parameters, or by providing the list of option IDs, only the IDs that are found will be returned.

## Path parameters

- `dimension` string, required
- `edition` string, required
- `id` string, required
- `version` string, required

## Query parameters

- `limit` integer
- `offset` integer
- `id` string

## Response `200`

Json object containing all options for a dimension

- DimensionOptions: A list of options for a specific dimension.
  - `count` integer: The number of items returned.
  - `limit` integer: The number of items requested.
  - `offset` integer: The offset of the first item to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter
  - `total_count` integer: The total number of items available.
  - `items` 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`: Invalid request, reasons can be one of the following: * dataset id was incorrect * edition was incorrect * version was incorrect * dimension was incorrect * query parameters incorrect offset provided * query parameters incorrect limit provided
- `404`: No dimension options were found for dimension
- `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)