Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

List Campaign Rewards

Returns active rewards from a given loyalty campaign.

get/v1/loyalties/{campaignId}/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.

Response

Returns a dictionary with reward assignment objects.

object'list'

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

data_refstring

Identifies the name of the attribute that contains the array of reward assignment objects.

totalinteger

Total number of reward assignment objects.

Example response

{
  "data": [
    {
      "id": "rewa_PbIRoMXpwe5QhobW4JKu0VjH",
      "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
      "created_at": "2022-08-11T14:49:22.586Z",
      "updated_at": "2022-08-11T16:01:34.885Z",
      "related_object_id": "camp_wciTvaOfYmAa3EmIIW3QpXXZ"
    }
  ]
}