Get rewards group by ID

This API allows you to retrieve details of a group using the group ID.

๐Ÿ‘

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/{id}
HTTP methodGET
PaginationNo
Rate limitNA
Batch supportNA

API endpoint example

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

Request path parameter

Parameter nameData TypeDescription
id*IntegerUnique identifier of the group.
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/group/14

Response parameters

Parameter NameData TypeDescription
idIntegerUnique identifier of the group.
orgIdIntegerIdentifier for the org.
nameStringName of the group.
rankIntegerRank associated with the group.
isActiveBooleanIndicates if the entry is active.
createdByIntegerIdentifier of the user who created the group.
createdOnLongTimestamp of when the group was created.
lastUpdatedByIntegerIdentifier of the user who last updated the group.
lastUpdatedOnLongTimestamp of the last update to the group.
{
    "id": 14,
    "orgId": 51226,
    "name": "VIP11",
    "rank": 2,
    "isActive": true,
    "createdBy": 50699846,
    "createdOn": 1707029506000,
    "lastUpdatedBy": 50699846,
    "lastUpdatedOn": 1707029506000
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!