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.

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/group/10417' \
--header 'Authorization: Basic bWFkaHVfjU2YQ==' \
--header 'Cookie: _cfuvid=BNKMdc2rm4I7MYA3KIlxZDn.nhxE7URS3m2d4Ipaduo-1764062400363-0.0.1.1-604800000'

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

Resource information


URI	/api_gateway/rewards/core/v1/group/`{id}`
HTTP method	GET
Pagination	No
Rate limit	NA
Batch support	NA

Request path parameter

Parameter name	Data Type	Description
id*	Integer	Unique identifier of the group.

Example response

{
    "id": 10417,
    "orgId": 100737,
    "name": "UAT Group 2",
    "rank": 2,
    "isActive": true,
    "createdBy": 75155292,
    "createdOn": 1758007038000,
    "createdOnDateTime": "2025-09-16T07:17:18Z",
    "lastUpdatedBy": 75155297,
    "lastUpdatedOn": 1758011894000,
    "lastUpdatedOnDateTime": "2025-09-16T08:38:14Z"
}

Response parameters

Parameter Name	Data Type	Description
id	Integer	Unique identifier of the group.
orgId	Integer	Identifier for the org.
name	String	Name of the group.
rank	Integer	Rank associated with the group.
isActive	Boolean	Indicates if the entry is active.
createdBy	Integer	Identifier of the user who created the group.
createdOn	Date	Creation date and time of the field in Epoch format
createdOnDateTime	String	Creation date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
lastUpdatedBy	Integer	Identifier of the user who last updated the group.
lastUpdatedOn	Date	Last Updated date and time of the field in Epoch format.
lastUpdatedOnDateTime	String	Last Updated date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)