Get user Balances

GET 
/v1/clients/:clientID/user-balances/:userId

Endpoint to retrieve current user Balances. Balances could be:

• Points
• Experience
• Scores (i.e. amount of correct answers for a given question)
• Any other numeric value

Request

Path Parameters

clientID stringrequired
userId stringrequired

Responses

200

Successful operation

application/json

Schema

Schema

• Array [
id uuid
authId number
clientId string
type string
balance number
updatedAt date-time
• ]

Example (from schema)

[
  {
    "id": "a5b703f7-089c-4b3f-ac55-36b688fada82",
    "authId": 1234,
    "clientId": "INCROWD",
    "type": "EXPERIENCE",
    "balance": 100,
    "updatedAt": "2023-09-21T18:35:26.234Z"
  }
]

Loading...