v1
latestOpenAPI 3.0.02026-07-1717466209.0 KBData Structures
Search data structure components across all DSDs
Paginated catalogue of components with parent DSD context. Requires at least one of search (min 2 characters), name, or structure_id.
get/data_structures/components
Query parameters
searchstring
Match component name, label, description, or parent DSD metadata.
qstring
Alias for search.
namestring
Prefix match on component name (e.g. REF_AREA).
column_type'dimension' | 'time_period' | 'measure' | 'attribute' | 'indicator_id' | 'indicator_name' | 'annotation' | 'geography' | 'observation_value' | 'periodicity'
agencystring
Filter by parent DSD agency.
structure_idinteger
Limit results to one DSD.
exclude_structure_idinteger
Exclude components from a DSD (e.g. current draft when copying).
status'draft' | 'review' | 'published' | 'deprecated' | 'archived'
Catalogue DSD lifecycle slug (persisted as an integer in data_structures.status): draft, review, published (locked from destructive edits), deprecated, archived (locked). Request bodies and import JSON must use these strings.
Filter by parent DSD status.
has_codelistboolean
When true, only components with a linked codelist.
pageinteger
per_pageinteger
order_by'name' | 'structure_title' | 'updated'
order_dir'ASC' | 'DESC'
Response
Paginated component search results