Get user reward by userRewardId

GET 
/userReward/:userRewardId

Get user reward by userRewardId

Request

Path Parameters

userRewardId userRewardIdrequired

The unique identifier for the userReward

Responses

200

UserRewards retrieved successfully

application/json

Schema

Schema

createdAt date-time
remainingUses integer
state userRewardState (string)

Possible values: [pending, redeemed, cancelled]

id userRewardId (string)

Unique identifier for UserReward

userId string
expiresAt date-time
rewardId string

Example (from schema)

{
  "createdAt": "2024-07-29T15:51:28.071Z",
  "remainingUses": 0,
  "state": "pending",
  "id": "UR3b19Z1n",
  "userId": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "rewardId": "string"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

Loading...