List all Redemptions

Use this function to list the status of all redemptions created as part of a promotion.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The promotion identifier

Query Params
string
string
string
string
enum

Redemption state filter (eg. pending, redeemed, canceled, etc.)

date-time

Filter redemptions redeemed on or after this datetime (ISO 8601 format, e.g. 2024-01-01T00:00:00Z)

date-time

Filter redemptions redeemed on or before this datetime (ISO 8601 format, e.g. 2024-01-31T23:59:59Z)

date-time

Filter redemptions activated on or after this datetime (ISO 8601 format, e.g. 2024-01-01T00:00:00Z)

date-time

Filter redemptions activated on or before this datetime (ISO 8601 format, e.g. 2024-01-31T23:59:59Z)

date-time

Filter redemptions refunded on or after this datetime (ISO 8601 format, e.g. 2024-01-01T00:00:00Z)

date-time

Filter redemptions refunded on or before this datetime (ISO 8601 format, e.g. 2024-01-31T23:59:59Z)

string
enum

Field to sort by, prefixed with - for descending order (e.g. activation_datetime or -activation_datetime)

integer | null
≥ 1
Defaults to 1
integer | null
1 to 10000
Defaults to 20
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json