---
title: "GET /api/collection/{id}/items/metadata"
method: GET
path: "/api/collection/{id}/items/metadata"
tags: ["/api/collection"]
---

# GET /api/collection/{id}/items/metadata

`GET /api/collection/{id}/items/metadata`

## Request

- Base URL: `` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/collection/{id}/items/metadata`
- Auth: API key in header `X-API-Key`

Metadata about the collection's items list: the models with at least one visible item plus the item count. Unlike
  `GET /api/collection/:id/items`, the result does not depend on search text; pass that endpoint's other scope
  params -- `models`, `archived`, `pinned-state`, `show-dashboard-questions`, `show-exploration-documents` -- so the
  metadata describes the list being shown.

## Path parameters

- `id` union, required
  - integer: value must be an integer greater than zero.
  - string: String must be a valid 21-character NanoID string.

## Query parameters

- `models` string[], nullable
- `archived` boolean, nullable: value must be a valid boolean string ('true' or 'false').
- `pinned-state` 'is_not_pinned' | 'is_pinned' | 'all', nullable
- `show-dashboard-questions` boolean, nullable: value must be a valid boolean string ('true' or 'false').
- `show-exploration-documents` boolean, nullable: value must be a valid boolean string ('true' or 'false').

## Response `2XX`

Successful response

- MetabaseCollectionsRestApiItemsMetadata
  - `available_models` string[], required
  - `total_items` integer, required: value must be an integer greater or equal to than zero.

## Other responses

- `4XX`: Client error response
- `5XX`: Server error response

## Changes

- **2026-11-04** `2e178f5a7934`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/metabase/apis/metabase-api/changes/api/collection/:id/items/metadata/get.md)

---

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