Skip to main content
GET
Browse Catalog

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

registry_type
string
required

Catalog type to browse

q
string | null

Free-text filter over name and description

category
string | null

Restrict to one category facet

sort
string | null

'featured' (default) or 'name'

limit
integer
default:50
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

One page of a type's catalog plus the context needed to browse it.

total and categories cover the whole filtered catalog, not the page: without them a page that happens to contain no visible matches is indistinguishable from the end of the catalog, and facet counts drift as more pages load.

categories
CategoryFacet · object[]
required
items
RegistryItemResponse · object[]
required
total
integer
required