Skip to main content
Returns the current loyalty points balance for a customer, including total earned and redeemed. GET /public/customers/balance

​
Authorizations

Authorization string header required Bearer authentication header of the form Bearer <token>, where <token> is your REST API token.

​
Required Scope

customers:read This endpoint requires the customers scope with Read Access. Configure token scopes in Settings → Integrations → REST API.

​
Query Parameters

customer_id string required The platform customer ID (e.g. Shopify customer ID) Example: "9049402769586"

​
Response

200 - application/json data object Hide child attributes data.customer_id string The platform customer ID. Example: "9049402769586" data.balance integer The customer’s current redeemable points balance. Example: 350 data.earned integer Total loyalty points ever earned by the customer. Example: 500 data.redeemed integer Total points the customer has redeemed. Example: 150 
curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers/balance?customer_id=9049402769586" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "data": {
    "customer_id": "9049402769586",
    "balance": 350,
    "earned": 500,
    "redeemed": 150
  }
}