| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This API allows you to retrieve details of a group using the group ID.
NoteFor 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/v1/badges/group/69708faa0772ad476ecf8511' \
--header 'Authorization: Basic bWFkaHV3MjU2YQ==' \
--header 'Cookie: _cfuvid=LbgLgMATQVG7rxgU6obNtuTjuntKzGkHg15XluHdUPI-1768984490920-0.0.1.1-604800000'Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
| URL | api_gateway/v1/badges/group/{groupId} |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/v1/badges/group/{groupId}
Request path parameters
| Parameters | Data Type | Description |
|---|---|---|
| groupId* | String | Unique ID of the group. Ex: 6560ad9c7e3e81134376008b |
Request query parameters
| Parameters | Data Type | Description |
|---|---|---|
| order | Enum | Sort response based on order. Supported values: ASC and DESC |
| size | Integer | The number of items or records returned in a single API response. |
| page | Integer | The amount of the data that you want to retrieve. Default value: 10. |
| status | Boolean | Indicates whether the group is active. Ex: Set the status to true to |
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/group/6581281e8f68666070de15c5Example response
{
"data": {
"id": "69708faa0772ad476ecf8511",
"orgId": 100737,
"name": "skjhfdjfhgiok",
"rank": 214748364,
"createdBy": 75197372,
"createdOn": 1768984490.856000000,
"createdOnISO": "2026-01-21T08:34:50Z",
"lastUpdatedBy": 75197372,
"lastUpdatedOn": 1768984490.856000000,
"lastUpdatedOnISO": "2026-01-21T08:34:50Z",
"isActive": true
},
"errors": null,
"warnings": null
}Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| id | String | Unique ID of the group. |
| orgId | Integer | Unique ID of the org. |
| name | String | Name of the group. |
| rank | Integer | Rank of the group. |
| createdBy | Integer | ID of the user who created the group. |
| createdOn | Timestamp | Timestamp when the group was created, in epoch timestamp format. |
| createdOnISO | String | Timestamp when the group was created, in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| lastUpdatedBy | Integer | ID of the user who last updated the group. |
| lastUpdatedOn | Timestamp | Timestamp when the group was last updated, in epoch timestamp format. |
| lastUpdatedOnISO | String | Timestamp when the group was last updated, in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| isActive | Boolean | Indicates whether the group is active |
| errors | Object | Indicates that there are no errors |
| warnings | Object | Indicates that there are no warnings |