Metadata

The /api/meta/* endpoints expose the platform's own structure — every registered route and every available scope. They are introspection endpoints, useful for:

• Building admin UIs that need a complete inventory of routes (e.g., role designers, scope-set builders).
• Auditing what the running deployment exposes vs. what is documented.
• Programmatically pinning client code against the live route surface.

These endpoints follow the same pagination and filter metadata conventions as the rest of the API.

Scopes

All metadata endpoints are readable by any authenticated user — none require an explicit scope. (Authentication is still required.)

Endpoints

List Routes

GET /api/meta/routes/

Returns a page of all routes the API knows about — path, method, required scope(s), tags, etc.

Required scope: none

Query parameters — see Conventions › Pagination.

Name	Type	Default	Notes
cursor	string	—	Cursor token for next page.
limit	integer	50	1–250.
sort_by	string	id	Any sortable field — see filters.
sort_order	string	desc	asc or desc.
include_total	boolean	true	Skip total count for faster pages.

Response 200 — RouteInDbCursorPage

Get Route by ID

GET /api/meta/routes/{id}

Returns a single route record.

Required scope: none

Path parameters

Name	Type	Required	Description
id	string	yes	Route record ID.

Response 200 — RouteRead

Get Route Filter Metadata

GET /api/meta/routes/filters

Returns filter and sort options for the route list — see Conventions › Filter Metadata.

Required scope: none

Response 200 — open metadata object.

List Scopes

GET /api/meta/scopes/

Returns a page of all scope definitions known to the platform. This is the canonical source of truth that Admin › Scope Sets and the Scopes reference document are built from.

Required scope: none

Query parameters — same set as List Routes.

Response 200 — ScopeInDbCursorPage

Get Scope Filter Metadata

GET /api/meta/scopes/filters

Returns filter and sort options for the scope list.

Required scope: none

Response 200 — open metadata object.

See also

• Scopes — human-readable scope catalogue.
• Admin › Scope Sets — managing the named scope bundles that get attached to users and API keys.
• Conventions › Filter Metadata Endpoints — the universal pattern these /filters endpoints follow.