Jump to Content

Home User Documentation Developer Documentation Releases

Home User Documentation Developer Documentation Releases

Getting started

Overview
API reference index
Authentication
Authorisation
Rate limits
API status codes
Timezone management
Make your first API request
Plugins
- Shopify plugin
- Magento plugin

mobile SDKs

Android SDK
iOS SDK

v3

Milestone & Streaks APIs
Event notification logs

v2 API Reference

Coupon Upload
Customer
Customer (Lookup)
Transaction
OTP
Points
Points Ledger
Coupon
Customer Labels
User Authentication
Organization
User Group
Cards
Partner Program
Company
Behavioral Events
Staff
Leads
Other APIs
PII deletion
Requests
Transaction rejection
Communications
- Send communication messagepost
- Error code
Referral
- Validate Referral Codeget
Loyalty Promotion
- Enrol or issue loyalty promotionpost
- Get promotion data of a specific customerget

v1.1 API Reference

Customer
Transaction
Points
Coupon
Communications
- Send communication messagepost
- Error code
Request
Task
Organization
Store
Product

Customer v1.1

Customer Authentication (Web/Mobile)
- First factor authentication
Multi-factor authentication
Authentication configurations
Change identifier on Auth enginepost
Loyalty Promotions
Coupon Upload
Recommendations
Cart Promotions
Rewards Catalog
Meta search
- Perform searchpost
Badges

Powered by

Getting started

Overview
API reference index
Authentication
Authorisation
Rate limits
API status codes
Timezone management
Make your first API request
Plugins
- Shopify plugin
- Magento plugin

mobile SDKs

Android SDK
iOS SDK

v3

Milestone & Streaks APIs
Event notification logs

v2 API Reference

Coupon Upload
Customer
Customer (Lookup)
Transaction
OTP
Points
Points Ledger
Coupon
Customer Labels
User Authentication
Organization
User Group
Cards
Partner Program
Company
Behavioral Events
Staff
Leads
Other APIs
PII deletion
Requests
Transaction rejection
Communications
- Send communication messagepost
- Error code
Referral
- Validate Referral Codeget
Loyalty Promotion
- Enrol or issue loyalty promotionpost
- Get promotion data of a specific customerget

v1.1 API Reference

Customer
Transaction
Points
Coupon
Communications
- Send communication messagepost
- Error code
Request
Task
Organization
Store
Product

Customer v1.1

Customer Authentication (Web/Mobile)
- First factor authentication
Multi-factor authentication
Authentication configurations
Change identifier on Auth enginepost
Loyalty Promotions
Coupon Upload
Recommendations
Cart Promotions
Rewards Catalog
Meta search
- Perform searchpost
Badges

Powered by

Referral

Referral is an act of directing new customers to the org stores.

A person that refers is a referral and the person that receives the referral invite is a referee.