get
https://{host}/api_gateway/v1/badges/group
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This API allows you to retrieve details of all the groups that are available in the org.
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 .
Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
| URI | api_gateway/v1/badges/group |
| HTTP method | GET |
| Pagination | Yes |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/group?size=100&page=0&order=ASC
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. |
{
"data": {
"badgeGroups": [
{
"id": "67ebaa886666db076c3c757e",
"orgId": 100737,
"name": "GROUP_RANK_2",
"rank": 2,
"createdBy": 75161973,
"createdOn": 1743497864.510000000,
"createdOnISO": "2025-04-01T08:57:44Z",
"lastUpdatedBy": 75161973,
"lastUpdatedOn": 1743497864.510000000,
"lastUpdatedOnISO": "2025-04-01T08:57:44Z",
"isActive": true
},
{
"id": "690871a02814b4096eba364b",
"orgId": 100737,
"name": "jehrwjer",
"rank": 2,
"createdBy": 75176138,
"createdOn": 1762161056.796000000,
"createdOnISO": "2025-11-03T09:10:56Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762161056.796000000,
"lastUpdatedOnISO": "2025-11-03T09:10:56Z",
"isActive": true
},
{
"id": "6908730a2814b4096eba3656",
"orgId": 100737,
"name": "ewrewrwer",
"rank": 2,
"createdBy": 75176138,
"createdOn": 1762161418.830000000,
"createdOnISO": "2025-11-03T09:16:58Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762161418.830000000,
"lastUpdatedOnISO": "2025-11-03T09:16:58Z",
"isActive": true
},
{
"id": "6908731a7d46045db5a44312",
"orgId": 100737,
"name": "ewrweewrwerwerwerwer",
"rank": 0,
"createdBy": 75176138,
"createdOn": 1762161434.268000000,
"createdOnISO": "2025-11-03T09:17:14Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762161434.268000000,
"lastUpdatedOnISO": "2025-11-03T09:17:14Z",
"isActive": true
},
{
"id": "690873332814b4096eba365e",
"orgId": 100737,
"name": "werwerwrw",
"rank": 23423424,
"createdBy": 75176138,
"createdOn": 1762161459.779000000,
"createdOnISO": "2025-11-03T09:17:39Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762161459.779000000,
"lastUpdatedOnISO": "2025-11-03T09:17:39Z",
"isActive": true
},
{
"id": "690873b67d46045db5a44324",
"orgId": 100737,
"name": "skjhfdjfhgsj",
"rank": 214748364,
"createdBy": 75176138,
"createdOn": 1762161590.436000000,
"createdOnISO": "2025-11-03T09:19:50Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762161590.436000000,
"lastUpdatedOnISO": "2025-11-03T09:19:50Z",
"isActive": true
},
{
"id": "690874cd2814b4096eba3662",
"orgId": 100737,
"name": "45345545445435",
"rank": 2,
"createdBy": 75176138,
"createdOn": 1762161869.946000000,
"createdOnISO": "2025-11-03T09:24:29Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762166043.659000000,
"lastUpdatedOnISO": "2025-11-03T10:34:03Z",
"isActive": true
},
{
"id": "690883f97d46045db5a443a4",
"orgId": 100737,
"name": "6456564564",
"rank": 2,
"createdBy": 75176138,
"createdOn": 1762165753.356000000,
"createdOnISO": "2025-11-03T10:29:13Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762166079.753000000,
"lastUpdatedOnISO": "2025-11-03T10:34:39Z",
"isActive": true
},
{
"id": "690889237d46045db5a443a8",
"orgId": 100737,
"name": "Group_01",
"rank": 24,
"createdBy": 75176138,
"createdOn": 1762167075.823000000,
"createdOnISO": "2025-11-03T10:51:15Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762167092.808000000,
"lastUpdatedOnISO": "2025-11-03T10:51:32Z",
"isActive": true
},
{
"id": "6908893e7d46045db5a443a9",
"orgId": 100737,
"name": "i3uy32i4",
"rank": 24,
"createdBy": 75176138,
"createdOn": 1762167102.273000000,
"createdOnISO": "2025-11-03T10:51:42Z",
"lastUpdatedBy": 75176138,
"lastUpdatedOn": 1762403562.302000000,
"lastUpdatedOnISO": "2025-11-06T04:32:42Z",
"isActive": true
}
],
"pagination": {
"page": 0,
"size": 10,
"total": 19,
"totalPages": 2
}
},
"errors": [],
"warnings": []
}Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| id | String | Unique identifier of the item |
| orgId | Integer | Organization identifier |
| name | String | Name of the item |
| rank | Integer | Rank of the item |
| createdBy | Integer | ID of the user who created the item |
| createdOn | Timestamp | Timestamp when the item was created |
| createdOnISO | String | Timestamp when the item 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 item |
| lastUpdatedOn | Timestamp | Timestamp when the item was last updated |
| lastUpdatedOnISO | String | Timestamp when the item 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 item is active |