Skip to main content
GET
/
v1
/
customers
/
{identifier}
/
reward-history
List reward history
curl --request GET \
  --url https://api.mageloyalty.com/v1/customers/{identifier}/reward-history \
  --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 a customer’s redeemed reward history. The identifier can be a Shopify customer ID or email.

​
Query parameters

ParameterTypeDescription
filter[status]stringFilter by status: active, used, expired
sortstringSort field. Prefix with - for descending. Options: created_at, points_spent. Default: -created_at
page[number]integerPage number (default: 1)
page[size]integerResults per page (default: 20, max: 100)

​
Response

{
  "data": [
    {
      "type": "reward_history_entry",
      "id": "cr_abc123",
      "attributes": {
        "reward_id": "reward_abc",
        "reward_name": "\u00a35 off your next order",
        "reward_discount_type": "fixed",
        "points_spent": 500,
        "discount_code": "MAGE-ABC123",
        "status": "active",
        "is_refunded": false,
        "discount_code_redeemed_at": null,
        "redeemed_at": "2024-06-01T12:00:00.000Z",
        "expires_at": "2024-07-01T12:00:00.000Z",
        "created_at": "2024-06-01T12:00:00.000Z",
        "updated_at": "2024-06-01T12:00:00.000Z"
      }
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}