Introduction

This section contains no articles.

Authentication

• Authentication

  Welcome to our Public API! This API allows you to securely integrate your app or service with our platform, giving you programmatic access to customer data, loyalty points, and rewards. To start using the Public API, you’ll first need to retrieve your unique API key. Follow these steps: From the Navigation Tab, click on Settings. Scroll down to the Public API section. Locate your API key and clickFew readers

Customers

• Customers

  Get customer list Retrieve a paginated list of customers from your loyalty program GET /rest-api/v1/customers Query parameters ResponseFew readers

Rewards

• Rewards

  Get customer rewards Retrieve a list of rewards earned by a customer GET /rest-api/v1/rewards Query parameters Response CopyPopular

Activities

• Activities

  Get customer activities Retrieve activities for a customer, such as redeemed rewards or earned points GET /rest-api/v1/activities Query parameters ResponseFew readers

Points

• Points

  Add points Add customer loyalty points POST /rest-api/v1/points/add Body Response Subtract points Subtract customer loyalty points POST /rest-api/v1/points/substract BodyFew readers