get https://{host}/api_gateway/core/v1/group/
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 method | GET |
| Pagination | No |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com//api_gateway/core/v1/group/14
Request path parameter
| Parameter name | Data Type | Description |
|---|---|---|
| id* | Integer | Unique identifier of the group. |
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/group/14
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 | Long | Timestamp of when the group was created. |
| lastUpdatedBy | Integer | Identifier of the user who last updated the group. |
| lastUpdatedOn | Long | Timestamp 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
}