Loyaltey API
The REST API lets you read and write the same loyalty data you see in the dashboard: customers, programs, cards, stamps and redemptions. Use it to connect a system Loyaltey has no ready-made integration for.
Authentication
- API access is included on the Pro and Enterprise plans (pricing).
- Create an API key in the dashboard under Integrations → API. Keys start with
lp_live_orlp_test_and are shown once; only a hash is stored. - Each key carries scopes, such as
customers:readorstamps:write. A request outside the key's scopes is refused. - Send the key on every request:
Authorization: Bearer YOUR_API_KEY. - Base URL:
https://loyaltey.com/api/v1. Requests and responses are JSON. List endpoints acceptpageandpageSize. - Rate limit: 100 requests per hour per key. Over the limit you get HTTP 429 with
Retry-After(seconds),X-RateLimit-Limit,X-RateLimit-RemainingandX-RateLimit-Reset.
curl https://loyaltey.com/api/v1/customers?page=1&pageSize=20 \
-H "Authorization: Bearer lp_live_..."Customers
Loyalty members of your business.
| Endpoint | Scope | What it does |
|---|---|---|
GET/customers | customers:read | List customers, with search, sorting and pagination. |
POST/customers | customers:write | Create a customer. |
GET/customers/{id} | customers:read | Get one customer. |
PUT/customers/{id} | customers:write | Update a customer. |
DELETE/customers/{id} | customers:write | Delete a customer. |
Programs
Stamp and points programs.
| Endpoint | Scope | What it does |
|---|---|---|
GET/programs | programs:read | List programs. |
POST/programs | programs:write | Create a program. |
Cards and stamps
A customer’s card in a program, and the stamps on it.
| Endpoint | Scope | What it does |
|---|---|---|
GET/cards | cards:read | List loyalty cards. |
POST/cards | cards:write | Enroll a customer in a program. |
GET/cards/{id} | cards:read | Get one card with its balance. |
PUT/cards/{id} | cards:write | Update a card. |
POST/cards/{id}/stamps | stamps:write | Award stamps or points to a card. |
Redemptions
Rewards customers have claimed.
| Endpoint | Scope | What it does |
|---|---|---|
GET/redemptions | redemptions:read | List redemptions. |
POST/redemptions | redemptions:write | Redeem a completed card. |
POS lookup
For point-of-sale integrations that identify members at checkout.
| Endpoint | Scope | What it does |
|---|---|---|
GET/pos/lookup | pos:lookup | Look up a member by identifier. |
Webhooks
Add webhook endpoints in Integrations → Webhooks. Loyaltey sends these events today:
| Event | Sent when |
|---|---|
customer.created | A customer is created by the Shopify or WooCommerce integration. |
card.created | A customer joins a loyalty program. |
stamp.added | Stamps are awarded automatically from a connected POS, Shopify or WooCommerce sale. |
card.completed | An automatically awarded stamp completes a card. |
redemption.created | A customer redeems a reward. |
order.paid | A connected Shopify or WooCommerce order is paid. |
order.shipped | A connected Shopify or WooCommerce order is marked shipped. |
order.delivered | A connected Shopify or WooCommerce order is marked delivered. |
order.cancelled | A connected Shopify or WooCommerce order is cancelled. |
The order.* events originate in your connected Shopify or WooCommerce store. Loyaltey does not take or process orders itself; it receives the store's order events to award stamps and passes them on.
Ready-made integrations
Before building your own, check the integrations: POS systems, Shopify, WooCommerce, email tools and more.
Try Loyaltey free
The Starter plan is free for up to 100 customers, with no credit card. Growth is €29/month for up to 2,500 customers.