Skip to main content
GET
/
v2
/
loyalties
/
rewards
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "validity_hours": {
        "daily": [
          {
            "days_of_week": [
              3
            ],
            "start_time": "09:00",
            "end_time": "17:00"
          }
        ]
      },
      "refunds": {},
      "costs": [
        {
          "id": "<string>",
          "rules": {
            "logic": "<string>"
          },
          "spending": [
            {
              "points": 123,
              "card_definition_id": "<string>"
            }
          ]
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "object": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "material": {
        "product": {
          "id": "<string>"
        },
        "sku": {
          "product_id": "<string>",
          "id": "<string>"
        }
      },
      "digital": {
        "discount_coupons": {
          "campaign_id": "<string>"
        },
        "gift_vouchers": {
          "campaign_id": "<string>",
          "balance": 123
        },
        "loyalty_card_points": {
          "points": 123,
          "card_definition_id": "<string>"
        }
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "object": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Query Parameters

limit
integer | null
default:10

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

Required range: 1 <= x <= 100
order

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.

Available options:
-created_at,
created_at,
name,
-name
cursor
string | null

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

Pattern: ^lcrsrew_[a-f0-9]+$
filters
object | null

Field-specific filter conditions, passed as a deep object, e.g. filters[name][conditions][$contains]=gift. See the RewardListFilters schema for available fields and conditions.

Filters for the rewards list. Each field accepts an object with a required conditions property. Conditions that are not supported for a given field type are rejected.

Response

Cursor-paginated list of rewards.

Cursor-paginated list of rewards.

data
object[]
required

The rewards on the current page.

cursor
object | null
required

Pagination cursor, or null when there are no more results.

object
string
required

Object type marker; always list.

Allowed value: "list"
Last modified on July 10, 2026