Skip to main content
GET
List product families

Authorizations

X-API-Key
string
header
required

Query Parameters

organization_id
string<shortuuid>

Only families owned by this organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
brand
string

Exact brand-name match.

Pattern: ^[^\x00]{0,}$
gtin
string

Only families that contain the product with this GTIN (any length, with or without separators). A value that isn't a valid GTIN matches nothing.

Pattern: ^[^\x00]{0,}$
external_ref
string

Exact external_ref match.

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

Page number (1-indexed).

Required range: x >= 1
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

OK

data
ProductFamilyOut · 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: