Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from
string
required

Starting record index, starting from 0

to
string
required

Ending record index, starting from 0

brand_id
string

The brand id to filter rewards

type
enum<string>

The type of the reward

Available options:
POINTS,
DISCOUNT,
GIFT_CARD,
PRODUCT
platform
string

Filter rewards by platform name

store_id
string

Filter by store id. Rewards with stores = null are included because they have no store restriction; rewards with a non-empty stores array are included only when it contains this id; rewards with stores = [] are excluded.

channel_id
string

Filter by channel id. Rewards with channels = null are included because they have no channel restriction; rewards with a non-empty channels array are included only when it contains this id; rewards with channels = [] are excluded.

product_id
string

Filter by product id. Rewards with products = null are included because they have no product restriction; rewards with a non-empty products array are included only when it contains this id; rewards with products = [] are excluded.

tier_id
string<uuid>

Filter by tier id. Rewards with tiers = null are included because they have no tier restriction; rewards with a non-empty tiers array are included only when it contains this id; rewards with tiers = [] are excluded.

Response

200 - application/json

Ok

data
object[]