---
title: "Get Collection Instruments Metadata"
method: GET
path: "/collection-instruments/metadata"
---

# Get Collection Instruments Metadata

`GET /collection-instruments/metadata`

## Request

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

GET method that returns any metadata objects from CIR that match the parameters passed.
The user has multiple ways of querying the metadata.

- Provide survey_id, classifiers, language.
- Provide no parameters. (all ci metadata is returned)

## Query parameters

- `classifier_type` 'form_type' | 'default'
- `classifier_value` string: classifier_value used by the CI
- `language` string: The language of the CI
- `survey_id` string: The survey_id of the CI

## Response `200`

Successful Response

- unknown

## Other responses

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

## Changes

- **2026-08-28** `e82a1a49216c`: 2 breaking, 1 info
  - removed the enum value `default` from the `query` request parameter `classifier_type`
  - removed the enum value `form_type` from the `query` request parameter `classifier_type`
  - for the `query` request parameter `classifier_type`, the type was generalized from `string` to no type
- **2026-08-27** `1e0c2422ae94`: 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
- **2026-05-01** `86630c625a29`: 6 info
  - `query` request parameter `classifier_value` list-of-types was widened by adding types `null`
  - `query` request parameter `language` 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 `classifier_value`, the type was generalized from `string` to no type
  - …2 more
- **2026-04-30** `fcb7af2e1be9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/collection-instrumentation-register/changes/collection-instruments/metadata/get.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/collection-instrumentation-register.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/collection-instrumentation-register/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/collection-instrumentation-register/revisions/7aeabd13e191?raw)
