v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Rewards

List Reward Assignments

Retrieve reward assignments by the reward ID.

get/v1/rewards/{rewardId}/assignments

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.

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.

objectstring required

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

data_refstring required

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

totalinteger required

Total number of reward assignments.

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"
    }
  ]
}