Skip to main content
GET
List 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
sort
enum<string> | null

Sort field, prefixed by - for descending (e.g. -rate). rate orders on whichever rate the offer advertises — perks.cashback.cashback_rate, perks.voucher.discount_rate or perks.coupon.discount_rate — all compared as percentages, so offer types rank against each other. An offer advertising no rate at all, such as a coupon carrying a fixed discount value, sorts last either way. Omit to keep the catalog's default order.

Available options:
rate,
-rate,
start_date,
-start_date
Example:

"-rate"

brand_id
string<uuid> | null

Filter offers by brand.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

brand__name
string | null

Filter offers by brand name (case-insensitive partial match).

Example:

"nike"

universe__name
string | null

Filter offers by the universe name of their brand (case-insensitive partial match). A brand sitting in several matching universes is still returned once.

Example:

"fashion"

type
enum<string> | null

Filter by offer type.

Available options:
CASHBACK,
LBS_CASHBACK,
VOUCHER
Example:

"CASHBACK"

highlight_level
string | null

Filter by display prominence. One of HIGHEST, HIGH or NORMAL — any other value matches no offer and returns an empty listing. Offers with no prominence set count as NORMAL.

Example:

"HIGHEST"

is_boosted
boolean | null

Filter on offers whose cashback rate is currently above their default rate — the same signal reported as perks.cashback.boosted. Offers that carry no cashback (vouchers, coupons) are never boosted, so they are returned by false and excluded by true.

Example:

true

is_consumed
boolean | null

Filter on is_consumed. Whether this consumer already used the offer — a claimed coupon, or a cashback earned up to the offer's cap.

Example:

false

Response

Successful Response

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