Get user groups
This endpoint is only available to Members and Administrators;
bots and guests cannot use this endpoint.
Fetches all of the user groups in the organization.
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Get all user groups of the realm
result = client.get_user_groups()
curl -sSX GET -G https://electron-builder.zulipchat.com/api/v1/user_groups \
This endpoint does not accept any parameters.
A list of
user_group objects, which contain a
id and the list of members of the user group.
The human-readable description of the user group.
The user group's integer id.
The integer user IDs of the user group members.
The integer user group IDs of the direct subgroups.
Changes: New in Zulip 6.0 (feature level 131).
Introduced in feature level 127 as
clients can ignore older events as this feature level
predates subgroups being fully implemented.
User group name.
Whether the user group is a system group which cannot be
modified by users.
Changes: New in Zulip 5.0 (feature level 93).
A typical successful JSON response may look like:
"description": "Characters of Hamlet",
"name": "other users"