v1

latestOpenAPI 3.1.02026-08-044257268.7 KB

Public Registry

List catalog categories

Flat, id-based list of category nodes (top groups, leaf categories, provider nodes) with live endpoint counts and the exact catalog total. Use the returned id values with GET /public/v1/endpoints?category=… (+ optional q=).

get/public/v1/categories

Query parameters

categorystring

Node id filter. A TOP id returns the top plus its member nodes; a leaf/provider id returns that single node. Omit for every node.

Example:social-media

Node id filter. A TOP id returns the top plus its member nodes; a leaf/provider id returns that single node. Omit for every node.

qstring

Optional free-text query — counts become per-node search hit counts (same BM25 semantics as GET /public/v1/endpoints?q=). Nodes with zero hits are omitted.

Example:twitter

Optional free-text query — counts become per-node search hit counts (same BM25 semantics as GET /public/v1/endpoints?q=). Nodes with zero hits are omitted.

Response

Category nodes

totalEndpointCountinteger required

Exact number of catalog-visible endpoints (with q: matching the query) — drives the All rail count.