Skip to main content
GET
List brands with offers visible to this consumer 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

Path Parameters

consumer_id
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"consumer-12345"

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:50
Required range: 1 <= x <= 1000
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"

perks__cashbacks
boolean | null

When true, only return brands with active cashback offers.

Example:

true

perks__vouchers
boolean | null

When true, only return brands with active voucher offers.

Example:

true

Response

Successful Response

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