Skip to main content
GET
List the rewards a consumer has received.

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

type
enum<string>[] | null

Filter on one or several reward types.

Available options:
CASHBACK,
GIFT,
CASHBACK_AFFILIATION,
LBS_CASHBACK
page
integer
default:1
Required range: x >= 1
per_page
integer
default:50
Required range: 1 <= x <= 1000
sort
enum<string>
default:-created_at
Available options:
created_at,
-created_at,
executed_at,
-executed_at
created_at__gte
string<date-time> | null
created_at__lte
string<date-time> | null
executed_at__gte
string<date-time> | null
executed_at__lte
string<date-time> | null

Response

Successful Response

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