Skip to main content
GET
List rewards

Authorizations

x-api-key
string
header
required

Query Parameters

status
Available options:
draft,
active,
paused,
expired,
archived
type
enum<string>
Available options:
DISCOUNT,
GATED_CONTENT,
FREE_CLAIM,
EARLY_ACCESS,
CREDIT
scope
enum<string>
Available options:
sitewide,
collection,
product,
variant
limit
number
Required range: 1 <= x <= 1000
offset
number
order
enum<string>
Available options:
asc,
desc
order_by
string
include_count
boolean

Response

200 - application/json

Successful response

data
object[]
required
pagination
object
required