Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get all available rewards for user in connected orgs

get/api_gateway/rewards/core/v1.1/user/rewards?userId={customerId}

Query parameters

userIdstring required

User ID of the customer

sortOnGroupsboolean

Pass ture to sort rewards based on group.

groupNamestring

Enter the group name to fetch all the rewards associated with the group.

includeExpiredstring
languagestring
areastring
citystring
countrystring
categorystring
labelstring
groupstring
tierstring
typestring
sortBystring
orderBystring
filterBystring
groupNamestring
sortOnGroupsstring

Headers

DATA-SCOPE-ORGstring required

List of Organization IDs

DATA-SCOPEstring required

The scope to authorize access (SELF, OTHER or ALL)

Response

200

OR
OR

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "User Reward fetched successfully"
  },
  "rewardList": [
    {
      "id": 282,
      "orgId": 4000084,
      "name": "Donations Test 2",
      "description": "Donations Test 2",
      "termAndConditionsId": "6356f6a7-0c95-4943-b25e-86df441a7e99",
      "termAndConditionsUrl": "https://ushc-crm-solutionsnbfwryxetc.s3.amazonaws.com/rewards/1ca9aa51-2901-4928-ba7a-1b9be04.html",
      "priority": 1,
      "startTime": "2024-10-15 08:29:00",
      "endTime": "2030-10-31 06:59:30",
      "started": true,
      "categoryList": [
        {
          "id": 6,
          "name": "lifestyle",
          "enabled": true
        }
      ],
      "rewardRestrictions": {
        "isValid": true
      },
      "paymentConfigs": [
        {
          "paymentMode": "CONV_RATIO",
          "id": 24,
          "conversionRatio": 1
        }
      ]
    }
  ],
  "pagingDto": {
    "last": true,
    "totalElements": 17,
    "totalPages": 1,
    "numberOfElements": 17,
    "size": 9
  },
  "orgLevelRestrictions": [
    {
      "isValid": true,
      "orgId": 4000084
    }
  ]
}