API Documentation

Get Points Balance

get
https://{host}/v2/customers//points/balance

Retrieves points balance of a customer from a single program or all programs of the org. Points are aggregated for each Point Category - Main, delayed accrual, and external trigger based.

This is a light API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Unique ID of the customer whose points balance needs to be fetched.

Query Params
int32

Unique ID of the loyalty program from which points balance needs to retrieve. If not passed, it shows the points balance in the default program.

string
enum

Pass CUSTOMER to fetch the individual customer’s points balance, FLEET to see group-level details. Default value is CUSTOMER.

Allowed:
boolean
Defaults to false

Pass true to fetch the sum of points balance from all the available programs of the org. Default value is false.

Headers
string
Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago