Get a group by ID
Retrieves detailed information about a specific call group, including its members, ring strategy, ring durations, and IVR assignments. Use this to inspect a group's configuration before making changes (e.g., adding/removing members, modifying ring duration).
Permission: No specific permission required. A valid API key is sufficient.
Monitoring impact:
- OFF: Returns the group only if you are a member of it. Returns 404 otherwise.
- ON: Returns any group in the team regardless of your membership.
Member pagination: limit_count and limit_offset paginate only the users sub-array (group members) of the response — they do not affect the group object itself. The response does not include a total member count: keep incrementing limit_offset until an empty users array is returned.
Path parameters
The identifier of the group
Query parameters
Maximum number of group members to include in the users array. Default: 100.
Number of group members to skip in the users array for pagination. Default: 0.
Response
Successful operation
Example response
{
"group_id": 999999,
"name": "myIVR",
"color": "FFD54F",
"users": [
{
"user_id": 123456,
"team_id": 123456,
"initial": "PM",
"color": "3CC8C8",
"firstname": "Pauline",
"lastname": "Martin",
"company": "Ringover",
"email": "pauline.martin@ringover.com",
"picture": "https://cdn77.ringover.com/img/users/default.jpg",
"concat_name": "Pauline Martin"
}
]
}