groups
List groups
Retrieves call groups (ring groups) configured for your team. Groups define how incoming calls are distributed among a set of users (simultaneous ring, round-robin, etc.). Each group includes its member list, ring strategy, and configuration.
Permission: No specific permission required. A valid API key is sufficient.
Monitoring impact:
- OFF: Returns only the groups you belong to as a member.
- ON: Returns all groups in the team, regardless of your membership.
Pagination: Results are returned in a stable order (by group id), so the same offset always yields the same page. To read every group, keep limit_count fixed and increase limit_offset by that amount on each request — this avoids the duplicates and gaps you would get from an unordered list.
get/groups
Query parameters
limit_countinteger
Example:100
Maximum number of groups to return. Default: 100.
limit_offsetinteger
Number of groups to skip for pagination. Default: 0.
Response
Successful operation
Example response
{
"list_count": 1,
"list": [
{
"group_id": 999999,
"name": "myIVR",
"color": "FFD54F"
}
]
}