Get user Rewards

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

Endpoint to retrieve rewards obtained by a user.

Request

Path Parameters

clientID stringrequired
userId stringrequired

Responses

200

Successful operation

application/json

Schema

Schema

• Array [
id uuid
authId number
clientId string
rewardId uuid
reward object
id uuid
created object
date date-time
editorAuthId number
data object
data field can contain any JSON value. This field gives the request some flexibility.
badgeUrl string
description string
lastModified object
date date-time
editorAuthId number
name string
type string
• ]

Example (from schema)

[
  {
    "id": "42fac465-9998-485c-bcbf-e42854afdf54",
    "authId": 1234,
    "clientId": "INCROWD",
    "rewardId": "a5b703f7-089c-4b3f-ac55-36b688fada82",
    "reward": {
      "id": "a5b703f7-089c-4b3f-ac55-36b688fada82",
      "created": {
        "date": "2023-09-21T18:35:26.234Z",
        "editorAuthId": 1
      },
      "data": {
        "badgeUrl": "https://media-cdn.incrowdsports.com/74140f6c-7eb8-420a-8162-02ae9312eac7.jpg"
      },
      "description": "Some test reward description",
      "lastModified": {
        "date": "2023-09-22T21:10:10.696Z",
        "editorAuthId": 1
      },
      "name": "Some test reward name",
      "type": "BADGE"
    }
  }
]

Loading...