Skip to main content
GET
List products

Authorizations

X-API-Key
string
header
required

Query Parameters

brand_short_id
string

Limit results to products belonging to the brand with this URL-safe short identifier.

Pattern: ^[^\x00]{0,}$
active
boolean

When true, return only currently-active products (resolver-enabled and not retired). When false, return only inactive products. Omit to return both.

ordering
string

Sort field; prefix with - for descending order. Allowed: product_name, created.

Pattern: ^[^\x00]{0,}$
page
integer
default:1

Page number (1-indexed).

Required range: 1 <= x <= 10000000
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

OK

data
ProductBrowseOut · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example: