Jump to Content

Home Guides API Reference Changelog

API Reference

Home Guides API Reference Changelog

Loyale API

Getting Started
Account
- Forgot Passwordpost
- Change passwordpost
Activity
- Get Activityget
Auth
- Get Tokenpost
Brand
- Get Brand by IDget
- Get Brandsget
Contact
- Get Contacts Matchpost
CouponsLinked
Customer
ExternalEventTrigger
- External Event Triggerpost
GiftCardsLinked
Group
- Get Group by IDget
- Get Groupsget
Helpers
Level
- Get Level by IDget
- Get Levelsget
Message
- Post a new messagepost
Outlet
- Get Outlet by IDget
- Get Outletsget
PostsLinked
- Get Post Linked by IDget
- Get Posts Linkedget
PushToken
Scheme
- Get Scheme by IDget
Transaction

Loyale Legacy POS Api

Getting Started
Auth
- Generate an access token for an Admin user.post
ExternalPos

Loyale POS Api

Getting Started
CouponsLinked
Customer
ExternalEventTrigger
- External Event Triggerpost
ExternalPos
- Post Transaction Simulatepost
GiftCard
- Get a List of Purchasable Gift Cardsget
GiftCardsLinked
Transaction
- Get Transaction by IDget
- Get Transactionsget

Integration API

Getting Started
Transaction Returns
Transactions
- Process a transactionpost
- Retrieve transaction status by unique IDget

Powered by

Get Scheme by ID

get https://api.loyale.io/api/v2/Scheme/{schemeId}

This endpoint returns one scheme by the id.

Language

Credentials

Header

Click Try It! to start a request and see the response here!