Skip to content

Get my reward point balance

Request

Returns the signed-in user's current reward point balance as a single number. The balance is the net of every points transaction on the account - points awarded for attending shifts, completing training or any other earning rule the organisation has configured, less anything already redeemed.

The balance is derived on read rather than stored, so it always reflects the transactions recorded at the moment of the call. A user who has never earned or redeemed anything gets 0 rather than an error, and so does a user on an account that does not use reward points at all - a zero balance is not a signal that the feature is switched off.

Security
default
Headers
Rosterfy-Platformstring
curl -i -X GET \
  https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/me/reward-point/balance \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Bodyapplication/json
balanceinteger
Response
{ "balance": 1000 }