Skip to main content
The Mage Loyalty API is organized around REST. It has predictable, resource-oriented URLs, uses standard HTTP methods, and returns JSON. All requests go to the versioned base URL. The current version is v1:

​
Authentication

Every request must include an API key in the Authorization header. You create and manage keys in the Mage Loyalty dashboard under Settings > API Keys (available on the Growth plan and above), and you can issue full-access or read-only keys. See Authentication to create your first key and start making requests.

​
Response format

Responses use a JSON:API-inspired shape. A single resource is wrapped in a data object with type, id, and attributes:
List endpoints return a data array alongside a meta object (see Pagination), and failed requests return an errors array (see Errors).

​
Rate limits

The API allows 6 requests per second per API key. See Rate limits for the response headers and retry guidance.

​
Available resources

Customers

Manage loyalty program members, points, and history

Earning Rules

Configure how customers earn points

Rewards

Manage available rewards and redemptions

VIP Tiers

View tier configurations and requirements