Fetch Points API

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

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

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.
Body Params
string
Defaults to storesAdmin.query.user_balance
string
Defaults to storeAdmin
variables
object
Headers
string
Defaults to eyJ0b2tlbkNvbnRlbnQiOnsiaXNzdWVkRm9yIjoiV29ya2F0by1Qb2ludHMtYXBpLWRlbW8tYWNjb3VudCIsInNjb3BlIjoiIiwiaXNzdWVkQXQiOjE3MTAzMzUzNzkzNTMsImV4cGlyZXNBdCI6IjIwMjQtMDMtMjhUMTM6MDk6MzkuMzUzWiIsInRva2VuX3R5cGUiOiJVU0VSIn0sImFfdCI6ImV5SmxibU1pT2lKQk1USTRRMEpETFVoVE1qVTJJaXdpWVd4bklqb2lSVU5FU0MxRlV5SXNJbXRwWkNJNkltVnVZeUlzSW1Wd2F5STZleUpyZEhraU9pSkZReUlzSW1OeWRpSTZJbEF0TWpVMklpd2llQ0k2SW1GdlJFMW5ZMXBXVlRFMmFHWjFOa3MwVUhCR1JXVmpRV1V5V2xSc2MwOUVla2haUW5kWWMyUXhZemdpTENKNUlqb2lVSGhEUWpodWRtZDFiSGRSYVhsc04wWkNiazVrTlhKMU0ydHJNVkp0ZEdzdE1XTmZPSEJ4Wm1vNFdTSjlmUS4uMjhqbjk4b1A3akI3d01ndlhhX0ppZy5Odks4NHNLLURVZTYwRXlvRXVhb1lJZlVrb0VRTVF5LU5FN3QtX3g1RDFzeDU1Z25RZ29TanY3WThKWHp3clJwMEYtSlRCemVHQ3gtX0w3cUppMDFPQWhsSFhNTjBfSVZWbXdOQ3NkUk5YQTVFWExnaXlkY2NYRUlWT0NIRGhsVFZveXA2MTh6aWFUVndXa2pCUHV6MllHUVFNdF9Wd3dnMDd6d2huc0k0ODFSQUY0dk45VlNvUTB4aUNIMnd0ZEFFZXpZamhoOUhzUGppb3k3UXpOZU15eDdWRllEZGhlWWVMUmdUZWFIRlJsWHg4SmZGNEpMY3c4X2JhdXhuQ2NITVVLNVVMTVl5ODFjdHYwT1VlNHh5WXp3elBpOGk2WEcwOWxJaExqWkdhZXpTeFI5dDU3NWUydjRCOHVGdFBpMW1vY3hXX3hUMWh1UXc5NnFEdWJqWXp1TmNSMkJaaDY2c3N0bU8tUE1pWTBUYjctcF81NzJhMFhJb0dkakoyMHpud0FteEd5NkhiWk04MDJCX3dBLXFKUk9LaFhBWXRPZzhrakwzUU8zaTBwVXBobUxFY254WmVNNjFkeERsakRNb292QkNEcW5pOUxJSHQxVFAzRFg2VVBnMWtVaGdfMkNWYUNCb3JqWk1YakdkRF9UZXVrVXRZWU5zcWVPSVZPd09DNk9yMkFraGRfdHpJNjBHaFdzUnFJNHBsWVdnRDA1WkNRdVNYbXdzTHZraExyWjdEeHliSU9CeDlIOHp2TVV1eTZxT2xvYlpOMENBTXUzRWdYVjgyWEhSR1hhRGVIMWw4RVJoOERmWkpKb2RXVGtRcmEtbU1lUmo5VExLVHBMLXJLc001QV9hODNqdENiTzlOZHBzQW9EYjZnWlAwWW96d01iaWNiOE5IRlZpdy1SY3gyN0lUTnk4TThXX0ZZV2tTYVFRYUpVSUtPZTJHb1ptTFU2azhzaWNBTkozUHZXZlB6X29nZXBxUmNMbXJ5a1ZIcktjel90M1ZTNVVPb21jaTZSU3ZoVGdtU0VnaXh6MDJJMHRWaDdmUEo5dHZXZ19Bc2tGY2ZUX0RSU0tHRXF0ZlJ1clFkTGF5NzVTb0RXNWc5N3Rxa0c1bFBWdV9GWnV5MGRMZy5ZWGFKcUJwUFhrS1NmYUVIckJCeGFBIn0=

This is user token.

Responses

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