Rewards

List reward activities

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Returns a cursor-paginated list of activities recorded for the given reward (created, updated, deleted, assigned, unassigned, activated, deactivated, drafted). Returns 404 when the reward does not exist.

get/v2/loyalties/rewards/{rewardId}/activities

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/rewards/{rewardId}/activities
  • Auth
    none required

Path parameters

idstring required

Unique reward identifier, prefixed with lrew_.

Query parameters

limitunknown

Maximum number of activities to return. Must be between 1 and 100. Defaults to 10 when not provided.

string[]
OR
'created_at' | '-created_at'

Field(s) to order results by. Prefix with - for descending order. Accepts a single value or an array of values. Defaults to -created_at. The same field cannot be used in both ascending and descending order at once.

cursorunknown

Pagination cursor returned in the cursor.next field of a previous response. Must match the pattern ^lcrsarew_[a-f0-9]+$.

junction'AND' | 'OR'

How multiple field filters are combined. Defaults to AND behavior.

Field-specific filter conditions, passed as a deep object, e.g. filters[type][conditions][$is]=vl.reward.created. See the RewardActivityListFilters schema for available fields and conditions.

Response

Cursor-paginated list of reward activities.

objectstring required

Object type marker; always list.

Example response

{
  "data": [
    {
      "data": {
        "reward": {
          "validity_hours": {
            "daily": [
              {
                "start_time": "09:00",
                "end_time": "17:00"
              }
            ]
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.