---
title: "Get a list for navigation"
method: GET
path: "/navigation"
tags: ["Public"]
---

# Get a list for navigation

`GET /navigation`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/navigation`
- Auth: none required

Get a list of topics for site navigation. This is currently unused.

## Query parameters

- `lang` string

## Response `200`

Provides a hierarchical list of navigation items with their links, copy, and localisation references.

- Navigation: Resource describing the structure for the ONS website navbar.
  - `description` string: A description of the navigation
  - `items` ListOfNavigationItems[]: An array of navigation items
    - object[]: A list of navigation items
      - `description` string: A human-readable description as a string
      - `label` string: The label to be displayed to a user, translated based on the lang parameter
      - `links` object
        - `self` SelfHref
          - `id` string: The ID of the resource.
          - `href` string: The URL to the resource.
      - `name` string: A hyphenated reference to the item
      - `slug` string: The slug of the item
      - `subtopics` object[]
        - `description` string: A human-readable description as a string
        - `label` string: The label to be displayed to a user, translated based on the lang parameter
        - `links` object
          - `self` SelfHref
            - `id` string: The ID of the resource.
            - `href` string: The URL to the resource.
        - `name` string: A hyphenated reference to the item
        - `slug` string: The slug of the item
        - `title` string: A string containing the title of something
        - `uri` string: The path to the resource on the web domain
      - `title` string: A string containing the title of something
      - `uri` string: The path to the resource on the web domain
  - `links` object
    - `self` object
      - `href` string: The URL to the resource

## Other responses

- `400`: The request was invalid.
- `500`: Failed to process the request due to an internal error.

---

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