---
title: "Get Dataset Metadata"
method: GET
path: "/v1/dataset_metadata"
deprecated: true
---

# Get Dataset Metadata

`GET /v1/dataset_metadata`

## Request

- The document declares no server URL.
- Auth: none declared

> **Deprecated.**

Retrieve the matching dataset metadata, given the survey_id and period_id.

Parameters:
survey_id (str): The survey id of the dataset being queried.
period_id (str): The period id of the dataset being queried.

## Query parameters

- `survey_id` string, nullable
- `period_id` string, nullable

## Response `200`

Successful Response

- DatasetMetadata[]
  - `dataset_id` string, required
  - `survey_id` string, required
  - `period_id` string, required
  - `form_types` string[], required
  - `sds_published_at` string, required
  - `total_reporting_units` integer, required
  - `sds_dataset_version` integer, required
  - `filename` string, required
  - `title` string, nullable

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `500`: Internal Server Error

## Changes

> 32 revisions in range; 2 not diffed.

- **2026-07-01** `9a87e51baf13`: 2 info
  - api operation id `get_dataset_metadata_collection_v1_dataset_metadata_get` removed and replaced with `Get_dataset_metadata_v1_dataset_metadata_get`
  - endpoint deprecated
- **2024-12-05** `0b183cf4153b`: 1 breaking
  - removed the required property `items/schema_version` from the response with the `200` status
- **2024-09-17** `d3f01a32165f`: 1 breaking, 4 info
  - response property `items/title` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - `query` request parameter `period_id` list-of-types was widened by adding types `null`
  - `query` request parameter `survey_id` list-of-types was widened by adding types `null`
  - for the `query` request parameter `period_id`, the type was generalized from `string` to no type
  - …1 more
- **2023-10-31** `72e05a262839`: 1 breaking
  - the response property `items/title` became optional for the status `200`
- **2023-08-25** `ac59298eeeb5`: 7 info
  - api operation id `get_dataset_metadata_collection_v1_dataset_metadata_get` was added
  - the `query` request parameter `period_id` became optional
  - the `query` request parameter `survey_id` became optional
  - added the media type `application/json` for the response with the status `200`
  - …3 more

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/supplementary-data-service/changes/v1/dataset_metadata/get.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/supplementary-data-service.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/supplementary-data-service/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/supplementary-data-service/revisions/9a87e51baf13?raw)