v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Rewards

List Rewards

Retrieve rewards.

get/v1/rewards

Query parameters

limitinteger

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.

pageinteger

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

assignment_idstring

Example:rewa_m9hEAu10KsPcLhGXiHG85aY0

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

Response

Returns a dictionary of reward objects.

objectstring required

The type of the object represented by JSON.

data_refstring required

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

totalinteger required

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

Example response

{
  "data": [
    {
      "id": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
      "parameters": {
        "product": {
          "id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619"
        }
      },
      "created_at": "2022-08-11T14:49:22.586Z",
      "updated_at": "2022-08-11T16:01:34.885Z"
    }
  ],
  "total": 20
}