Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Groups - Get all rewards group

get/api_gateway/rewards/core/v1/group

Query parameters

activestring

Indicates if the group is active.

namestring

Name of the group.

orderBy'ASC' | 'DESC'

Sort response based on order

pageinteger

The amount of the records that you want to retrieve

sortBy'RANK'

Sorts the reward based on the group rank.

Response

200

OR
OR

Example response

{
  "status": {
    "success": true,
    "code": 12013,
    "message": "Get all groups fetched successfully"
  },
  "groupRoList": [
    {
      "id": 2412,
      "orgId": 100737,
      "name": "groupName066",
      "rank": 8,
      "isActive": true,
      "createdBy": 75155282,
      "createdOn": 1742180328000,
      "createdOnDateTime": "2025-03-17T02:58:48Z",
      "lastUpdatedBy": 75155282,
      "lastUpdatedOn": 1742180328000,
      "lastUpdatedOnDateTime": "2025-03-17T02:58:48Z"
    }
  ],
  "pagingDto": {
    "last": true,
    "totalElements": 3,
    "totalPages": 1,
    "numberOfElements": 3,
    "first": true,
    "size": 10
  }
}