Skip to main content
GET
List Reward Assignments

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required

Scopes

api

Gives access to whole server-side API.

rewards

Gives access to all endpoints and methods starting with /v1/rewards.

Path Parameters

rewardId
string
required

A unique reward ID.

Example:

"rew_2erjvECLs92GYzKbak3QkyTV"

Query Parameters

limit
integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100
page
integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100

Response

Returns a dictionary of reward assignment objects. Each object contains information regarding the resource to which the reward was assigned and the cost in loyalty points for the reward (legacy loyalty or referral campaigns).

Response body schema for GET v1/rewards/{rewardID}/assignments.

object
string
default:list
required

The type of the object represented by JSON. This object stores information about reward assignments in a dictionary.

data_ref
string
default:data
required

Identifies the name of the attribute that contains the array of reward assignments.

data
Reward Assignment · object[]
required
total
integer
required

Total number of reward assignments.