Skip to main content
GET
List Rewards

Authorizations

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

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
assignment_id
string

A unique reward assignment ID. Use this parameter to get the reward details in the context of an assignment ID.

Example:

"rewa_m9hEAu10KsPcLhGXiHG85aY0"

Response

200 - application/json

Returns a dictionary of reward objects.

Response body schema for GET v1/rewards.

object
string
default:list
required

The type of the object represented by JSON.

data_ref
string
default:data
required

Identifies the name of the attribute that contains the array of transaction objects.

data
Reward · object[]
required

A dictionary that contains an array of rewards. Each entry in the array is a separate transaction object.

total
integer
required

Returns how many rewards in the project meet the limits defined by the query parameter definitions.

Example:

20

Last modified on July 7, 2026