> ## 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.

# Introduction

> The Mage Loyalty REST API lets you programmatically manage your loyalty program.

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`:

```
https://api.mageloyalty.com/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](/api-reference/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`:

```json theme={null}
{
  "data": {
    "type": "customer",
    "id": "6789012345",
    "attributes": {
      "email": "jane@example.com",
      "current_points": 450
    }
  }
}
```

List endpoints return a `data` array alongside a `meta` object (see [Pagination](/api-reference/pagination)), and failed requests return an `errors` array (see [Errors](/api-reference/errors)).

## Rate limits

The API allows 6 requests per second per API key. See [Rate limits](/api-reference/rate-limits) for the response headers and retry guidance.

## Available resources

<CardGroup cols={2}>
  <Card title="Customers" icon="users" href="/api-reference/customers/object">
    Manage loyalty program members, points, and history
  </Card>

  <Card title="Earning Rules" icon="coins" href="/api-reference/earning-rules/object">
    Configure how customers earn points
  </Card>

  <Card title="Rewards" icon="gift" href="/api-reference/rewards/object">
    Manage available rewards and redemptions
  </Card>

  <Card title="VIP Tiers" icon="crown" href="/api-reference/vip-tiers/object">
    View tier configurations and requirements
  </Card>
</CardGroup>