Skip to main content
GET
List brands with active offers in the program's catalog.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
required

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:50
Required range: 1 <= x <= 1000
sort
enum<string> | null

Sort field, prefixed by - for descending (e.g. -max_highlight_level). max_highlight_level orders on the brand's prominence, max_rate on the rate it headlines. A brand advertising no rate at all, listed only through a coupon offer, sorts last on max_rate either way. Omit to keep the catalog's brand-name order.

Available options:
max_highlight_level,
-max_highlight_level,
max_rate,
-max_rate
Example:

"-max_highlight_level"

name
string | null

Filter brands by name (case-insensitive partial match).

Example:

"nike"

universe__name
string | null

Filter brands by universe name (case-insensitive partial match).

Example:

"fashion"

max_highlight_level
string | null

Filter brands on max_highlight_level, returning exactly the brands reporting it. One of HIGHEST, HIGH or NORMAL — any other value matches no brand and returns an empty listing.

Example:

"HIGHEST"

Response

Successful Response

items
ProgramBrandSchema · object[]
required
meta
PageMeta · object
required