Skip to content

Reward Point

Read a reward point balance

Request

Returns one user's reward point balance: how many points they hold now, and who they belong to.

The record is the running total only. It does not carry the transactions that produced it, and there is no history in this response - read the reward point transactions for that.

The ID in the URL is the balance record's own ID, not the user's. To go from a user to their balance, list the balances and filter on user_id.

permissions always reports update and delete as unavailable: a balance is derived from the transactions recorded against it and is not writable through the API.

Security
default
Path
idintegerrequired

The ID of the reward point balance record.

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

Responses

Bodyapplication/json
objectobject
niceArray of any
relationsobject
permissionsobject
Response
{ "object": { "id": 1, "account_id": 20101, "user_id": 1234, "balance": 1250, "created_at": "2026-08-06T01:07:51.000000Z", "updated_at": "2026-08-06T01:07:51.000000Z", "deleted_at": null }, "nice": [], "relations": {}, "permissions": { "read": true, "update": false, "delete": false } }