---
title: "List codelists"
method: GET
path: "/codelists"
tags: ["Codelists"]
---

# List codelists

`GET /codelists`

List global codelists. Default: one row per family (collapsed). Use `flat=1` for all version rows. Requires `codelist:browse` (registry view) permission.

## Query parameters

- `flat` boolean
- `collapsed` boolean
- `page` integer
- `per_page` integer
- `search` string
- `q` string
- `agency` string
- `status` 'draft' | 'active' | 'locked' | 'archived' — Catalogue codelist lifecycle status
- `exclude_archived` boolean
- `with_counts` boolean
- `offset` integer
- `limit` integer

## Response `200`

Codelist catalogue rows

- CodelistListResponse
  - `status` 'success', required
  - `codelists` CodelistCatalogRow[], required
    - `id` integer
    - `idno` string
    - `agency` string
    - `name` string — SDMX maintainable id
    - `version` string
    - `title` string
    - `description` string
    - `status` 'draft' | 'active' | 'locked' | 'archived' — Catalogue codelist lifecycle status
    - `item_count` integer — Present when with_counts is enabled
    - `dsd_component_count` integer — Present when with_counts is enabled
    - `versions_count` integer — Present on collapsed family rows
  - `total` integer, required
  - `page` integer
  - `per_page` integer
  - `collapsed` boolean
  - `offset` integer
  - `limit` integer

## Other responses

- `400` — Bad request
- `403` — Registry access denied

---

[API](https://skmtc.net/worldbank/apis/metadata-editor-api.md) · [All operations](https://skmtc.net/worldbank/apis/metadata-editor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/worldbank/metadata-editor-api/revisions/f4c8258bab5a/schema)