Get user groups
GET https://crdt.zulipchat.com/api/v1/user_groups
Fetches all of the user groups in the organization.
Usage examples
#!/usr/bin/env python3
import zulip
# 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()
print(result)
curl -sSX GET -G https://crdt.zulipchat.com/api/v1/user_groups \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
This endpoint does not accept any parameters.
Response
Return values
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported
array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success",
"user_groups": [
{
"can_mention_group": 11,
"description": "Owners of this organization",
"direct_subgroup_ids": [],
"id": 1,
"is_system_group": true,
"members": [
1
],
"name": "role:owners"
},
{
"can_mention_group": 12,
"description": "Administrators of this organization, including owners",
"direct_subgroup_ids": [
1
],
"id": 2,
"is_system_group": true,
"members": [
2
],
"name": "role:administrators"
},
{
"can_mention_group": 13,
"description": "Characters of Hamlet",
"direct_subgroup_ids": [],
"id": 3,
"is_system_group": false,
"members": [
3,
4
],
"name": "hamletcharacters"
}
]
}