Fetch Points API

This API endpoint allows you to fetch points for each user (which can be be displayed inside your UI).

Fetch Points API Schema

PropertyTypeDescription
user_data.emailStringUser’s email ID to fetch balance.
user_data.phoneStringUser’s phone number to fetch balance.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.user_balanceobjectContainer for user points/balance data.
data.user_balance.successnumberAPI execution status (1 = success).
data.user_balance.messagestring/nullAPI message (null when no message is returned).
data.user_balance.dataobjectActual points data.
data.user_balance.data.totalnumberTotal available reward points for the user.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!