Skip to main content
GET
/
v1
/
rewards
List rewards
curl --request GET \
  --url https://api.mageloyalty.com/v1/rewards \
  --header 'Authorization: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt

Use this file to discover all available pages before exploring further.

List all rewards for the shop. Excludes soft-deleted rewards.

​
Query parameters

ParameterTypeDescription
filter[is_active]stringFilter by active status: true or false
sortstringSort field. Prefix with - for descending. Options: created_at, name, points_cost. Default: -created_at
page[number]integerPage number (default: 1)
page[size]integerResults per page (default: 20, max: 100)

​
Response

{
  "data": [
    {
      "type": "reward",
      "id": "reward_abc",
      "attributes": {
        "name": "£5 off your next order",
        "description": null,
        "discount_type": "fixed_amount",
        "reward_type": "discount",
        "points_cost": 500,
        "discount_amount": 5.00,
        "minimum_spend": 20.00,
        "is_active": true,
        "max_redemptions": null,
        "expiry_days": 30,
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
      }
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}