v1
latestOpenAPI 3.0.02026-07-1717466209.0 KBCodelists
List codelists
List global codelists. Default: one row per family (collapsed). Use flat=1 for all version rows. Requires codelist:browse (registry view) permission.
get/codelists
Query parameters
flatboolean
When true, return one row per version instead of collapsed families.
collapsedboolean
1 forces collapsed; 0 forces flat (overrides default).
pageinteger
1-based page number (max 200 per page).
per_pageinteger
searchstring
qstring
Alias for search.
agencystring
status'draft' | 'active' | 'locked' | 'archived'
Catalogue codelist lifecycle status
exclude_archivedboolean
with_countsboolean
Include item_count and dsd_component_count when true (default).
offsetinteger
Legacy pagination offset (used when page is omitted).
limitinteger
Legacy page size (used when page is omitted).
Response
Codelist catalogue rows