Introduction

This section contains no articles.

Authentication

• Authentication

  The BLOY Public API lets you integrate your app or service with BLOY Loyalty: programmatically access customer data, loyalty points, rewards, ways to earn, VIP tiers, and referrals. Base URL: https://api.bloy.io Data format: JSON Authentication: Bearer token (API Key) Authentication ${color}[#000000]( ) Get your API Key From the Navigation Tab, click on Settings. Scroll down to the Public API section. Locate your API kSome readers

Customers

• Customers

  Get customer list Retrieve a paginated list of customers from your loyalty program GET /rest-api/v1/customers Query parameters Name Type Description filter string Search by Shopify customer ID or customer email page int Page number pageSize int Number of results per page Example request curl --request GET \ --url 'https://api.bloy.io/rest-api/v1/customers?filter=customer@example.com&page=1&pageSize=20' \ --header 'AuthorSome readers

Rewards

• Rewards

  Get customer rewards Retrieve a list of rewards earned by a customer GET /rest-api/v1/rewards Query parameters Name Type Description customerIdentifier string Search by Shopify customer ID or customer email page int Page number pageSize int Number of results per page Example request curl --request GET \ --url 'https://api.bloy.io/rest-api/v1/rewards?customerIdentifier=customer@example.com&page=1&pageSize=20' \ --header 'AFew readers

Activities

• Activities

  Get customer activities Retrieve activities for a customer, such as redeemed rewards or earned points GET /rest-api/v1/activities Query parameters Name Type Description customerIdentifier string Search by Shopify customer ID or customer email page int Page number pageSize int Number of results per page Example request curl --request GET \ --url 'https://api.bloy.io/rest-api/v1/activities?customerIdentifier=customer@example.comFew readers

Points

• Points

  Add points Add loyalty points to a customer's balance. POST /rest-api/v1/points/add Body Name Type Description customerIdentifier string Shopify customer ID or email amount int Number of points to add description string Reason for the change note string Additional note Example request curl --request POST \ --url https://api.bloy.io/rest-api/v1/points/add \ --header 'Authorization: Bearer YourApiKeyGoesHere' \Few readers

Points Redemptions

• Points Redemptions

  List all points redemptions Retrieve all "ways to redeem" (redemption configurations) for the shop, including a redeemable flag indicating whether the given customer has enough points to redeem each one. GET /rest-api/v1/pointsRedemptions Query parameters Name Type Description customerIdentifier string Shopify customer ID or email (required) page int Page number (required) pageSize int Number of results per page (required, max 250)Few readers

• Earning Rules

  List Ways to Earn Retrieve the list of "ways to earn" (earning rule configurations) for the shop. GET /rest-api/v1/earningRules Query parameters Name Type Description page int Page number (required) pageSize int Number of results per page (required, max 250) Example request curl --request GET \ --url 'https://api.bloy.io/rest-api/v1/earningRules?page=1&pageSize=20' \ --header 'Authorization: Bearer YourApiKeyGoesHere' **ExampFew readers

• VIP

  Get the VIP program Retrieve the shop's active VIP program, including its tiers, perks, entry rewards, and per-tier earning rules. GET /rest-api/v1/vip Example request curl --request GET \ --url https://api.bloy.io/rest-api/v1/vip \ --header 'Authorization: Bearer YourApiKeyGoesHere' Example response { "success": true, "message": "OK", "data": [ { "id": "664f1a2b3c4d5e6f7a8b9c50", "status": true, "startDate": "2025-01-01T00:00:0Few readers

• Referral

  Get a customer's referral code Retrieve (or automatically generate, if not yet created) the customer's referral code. GET /rest-api/v1/referral Query parameters Name Type Description customerIdentifier string Shopify customer ID or email (required) Example request curl --request GET \ --url 'https://api.bloy.io/rest-api/v1/referral?customerIdentifier=customer@example.com' \ --header 'Authorization: Bearer YourApiKeyGoesHere' **ExampFew readers