---
title: "Get Metadata"
method: GET
path: "/api/metadata/"
tags: ["Metadata"]
---

# Get Metadata

`GET /api/metadata/`

## Request

- Base URL: `https://tickitto.tech` (the document declares no server; this is the origin it was published from)
- URL: `https://tickitto.tech/api/metadata/`
- Auth: API key in header `key`

Returns metadata describing the possible event locations and categories and any images or other information associated with them.

## Query parameters

- `include_empty` boolean: If true, includes all locations and categories, even if they have no events. Note that this will significantly increase response size.
- `filter_children` boolean
- `profile_name` string: Profile name
- `hostname` string: Associated hostname
- `should_raise` boolean

## Headers

- `origin` string
- `accept-language` string
- `X-Correlation-ID` string

## Response `200`

Successful Response

- Metadata: Metadata endpoint response model.
  - `categories` Category[], required: Information about event categories.
    - `localised_name` string: Localisable name.
    - `id` string: Unique MongoDB ID for this category
    - `name` string, required: Category name
    - `parent_name` string: Parent category name.
    - `children` string[]: List of child categories
    - `images` Image[]: URLs of images which can be used to represent this category.
      - `desktop` string: URL to use on desktop devices
      - `mobile` string: URL to use on mobile devices
      - `thumbnail` string: URL of a square version of this image
    - `event_count` integer: Number of events with this category which have availability.
  - `locations` Location[], required: Information about event locations
    - `localised_name` string: Localisable name.
    - `country_code` string, required: Unique two-letter ISO country code e.g. GB, DE, US
    - `alternate_names` string[]: Alternate names and other country-codes e.g. UK, GBR, Great Britain
    - `country_name` string, required: Country name e.g. United Arab Emirates
    - `images` SourcedImage[]: URLs of images which can be used to represent this country.
      - `desktop` string: URL to use on desktop devices
      - `mobile` string: URL to use on mobile devices
      - `thumbnail` string: URL of a square version of this image
      - `cache_id` string: Caching identifier
      - `source` string: Where this image was sourced from e.g. teleport
    - `cities` City[]: An array containing metadata about cities in this country.
      - `localised_name` string: Localisable name.
      - `name` string, required: Location name.
      - `group_name` string: Location grouping name.
      - `images` Image[]: URLs of images which can be used to represent this location.
        - `desktop` string: URL to use on desktop devices
        - `mobile` string: URL to use on mobile devices
        - `thumbnail` string: URL of a square version of this image
      - `latitude` number: Latitudinal position of the centre point of this location.
      - `longitude` number: Longitudinal position of the centre point of this location.
      - `event_count` integer: Number of events in this location which have availability.
      - `state` string: Parent state, if applicable.
    - `regions` Region[]: An array containing metadata about the regions in this country
      - `localised_name` string: Localisable name.
      - `name` string, required: Location name.
      - `group_name` string: Location grouping name.
      - `images` Image[]: URLs of images which can be used to represent this location.
        - `desktop` string: URL to use on desktop devices
        - `mobile` string: URL to use on mobile devices
        - `thumbnail` string: URL of a square version of this image
      - `latitude` number: Latitudinal position of the centre point of this location.
      - `longitude` number: Longitudinal position of the centre point of this location.
      - `event_count` integer: Number of events in this location which have availability.
      - `cities` City[]: An array containing a collection cities within the region.
        - `localised_name` string: Localisable name.
        - `name` string, required: Location name.
        - `group_name` string: Location grouping name.
        - `images` Image[]: URLs of images which can be used to represent this location.
          - `desktop` string: URL to use on desktop devices
          - `mobile` string: URL to use on mobile devices
          - `thumbnail` string: URL of a square version of this image
        - `latitude` number: Latitudinal position of the centre point of this location.
        - `longitude` number: Longitudinal position of the centre point of this location.
        - `event_count` integer: Number of events in this location which have availability.
        - `state` string: Parent state, if applicable.
    - `states` State[]: An array containing metadata about states in this country
      - `localised_name` string: Localisable name.
      - `name` string, required: Location name.
      - `group_name` string: Location grouping name.
      - `images` Image[]: URLs of images which can be used to represent this location.
        - `desktop` string: URL to use on desktop devices
        - `mobile` string: URL to use on mobile devices
        - `thumbnail` string: URL of a square version of this image
      - `latitude` number: Latitudinal position of the centre point of this location.
      - `longitude` number: Longitudinal position of the centre point of this location.
      - `event_count` integer: Number of events in this location which have availability.
      - `country_name` string: Country name e.g. United Arab Emirates
    - `event_count` integer: Number of events in this location which have availability.

## Other responses

- `401`: Unauthorized
- `422`: Validation Error

## Changes

- **2026-09-08** `71035d272191`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status

[Operation history](https://skmtc.dev/tickitto/apis/tickitto-api/changes/api/metadata/get.md)

---

[API](https://skmtc.dev/tickitto/apis/tickitto-api.md) - [All operations](https://skmtc.dev/tickitto/apis/tickitto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tickitto/apis/tickitto-api/revisions/22e674e2f052?raw)
