Get all user rewards by rewardId

GET 
/userRewards/by/reward/:rewardId

Get all user rewards by rewardId

Request

Path Parameters

rewardId rewardIdrequired

The unique identifier for the reward

Query Parameters

state userRewardState

Possible values: [pending, redeemed, cancelled]

The state to filter by

startDate date-time

Search by start date since claimedAt

endDate date-time

Search by end date until claimedAt

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of projects per page (default is 10, 0 gets all results).

sortBy string

Possible values: [createdAt, numMonthlyUsers, name]

Field to order the results by (e.g., 'createdAt', 'numMonthlyUsers'). Default is 'createdAt'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

UserRewards retrieved successfully

application/json

Schema

Schema

• Array [

expiresAt date-time
state userRewardState (string)

Possible values: [pending, redeemed, cancelled]

rewardId string
userId string
remainingUses integer
id userRewardId (string)

Unique identifier for UserReward

createdAt date-time

• ]

Example (from schema)

[
  {
    "id": "URdef4567",
    "status": "pending",
    "rewardId": "r135HCrJs",
    "createdAt": "2024-10-30T12:00:00Z",
    "userId": "83688660-e49e-4b3c-9ad2-22fa1ee69288"
  },
  {
    "createdAt": "2024-10-29T09:30:00Z",
    "id": "UR0123abc",
    "rewardId": "r135HCrJs",
    "status": "redeemed",
    "userId": "83688660-e49e-4b3c-9ad2-22fa1ee69288"
  }
]

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...