Get rewards group

This API allows you to retrieve details of all the reward groups available in the org.

๐Ÿ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/core/v1/group
HTTP methodGET
PaginationYes
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/core/v1/group

Request query parameters

ParametersData typeDescription
orderByEnumSort response based on order. Supported values: ASC and DESC
activeBooleanIndicates if the group is active.
nameStringName of the group. Enter the group name to retrieve group details.
sizeIntegerThe number of items or records returned in a single API response.
pageIntegerThe amount of the data that you want to retrieve. Default value: 10.
https://crm-nightly-new.cc.capillarytech.com/api_gateway/rewards/core/v1/group?page=0&size=10&active=true&name=VIP&orderBy=ASC

Response parameters

Parameter NameData TypeDescription
idIntegerThe unique identifier of the group.
orgIdIntegerThe organization identifier the group belongs to.
nameStringThe name of the group.
rankIntegerThe numerical rank associated with the group.
isActiveBooleanIndicates if the group is active.
createdByIntegerThe identifier of the user who created the group.
createdOnLongThe timestamp when the group was created.
lastUpdatedByIntegerThe identifier of the user who last updated the group.
lastUpdatedOnLongThe timestamp when the group was last updated.
lastBooleanIndicates if the current page is the last page.
totalElementsIntegerThe total number of elements across all pages.
totalPagesIntegerThe total number of pages available.
numberOfElementsIntegerThe number of elements in the current page.
firstBooleanIndicates if the current page is the first page.
sizeIntegerThe number of elements per page.
numberIntegerThe current page number (zero-based).
codeIntegerThe code associated with the operation status.
messageStringA message describing the operation outcome.
successBooleanIndicates if the operation was successful.
{
    "status": {
        "success": true,
        "code": 12013,
        "message": "Get all groups fetched successfully"
    },
    "groupRoList": [
        {
            "id": 7,
            "orgId": 51226,
            "name": "VIP4",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029484000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029484000
        },
        {
            "id": 8,
            "orgId": 51226,
            "name": "VIP5",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029488000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029488000
        },
        {
            "id": 9,
            "orgId": 51226,
            "name": "VIP6",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029491000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029491000
        },
        {
            "id": 10,
            "orgId": 51226,
            "name": "VIP7",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029494000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029494000
        },
        {
            "id": 11,
            "orgId": 51226,
            "name": "VIP8",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029497000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029497000
        },
        {
            "id": 12,
            "orgId": 51226,
            "name": "VIP9",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029500000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029500000
        },
        {
            "id": 13,
            "orgId": 51226,
            "name": "VIP10",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029503000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029503000
        },
        {
            "id": 14,
            "orgId": 51226,
            "name": "VIP11",
            "rank": 2,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707029506000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707029506000
        },
        {
            "id": 3,
            "orgId": 51226,
            "name": "VIP14",
            "rank": 78,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707025497000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707034678000
        },
        {
            "id": 4,
            "orgId": 51226,
            "name": "VIP17",
            "rank": 78,
            "isActive": true,
            "createdBy": 50699846,
            "createdOn": 1707025500000,
            "lastUpdatedBy": 50699846,
            "lastUpdatedOn": 1707034713000
        }
    ],
    "pagingDto": {
        "last": false,
        "totalElements": 28,
        "totalPages": 3,
        "numberOfElements": 10,
        "first": true,
        "size": 10,
        "number": 0
    }
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!