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://pelikan.zulipchat.com/api/v1/user_groups \
This endpoint does not accept any parameters.
user_groups: (object) A list of
user_group objects, which contain a
id and the list of members of the user group.
description: string The human-readable description of the user group.
id: integer The user group's integer id.
members: (integer) The integer user IDs of the user group members.
name: string User group name.
is_system_group: boolean 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"