Get user groups

Fetches all of the user groups in the organization.

GET https://yourZulipDomain.zulipchat.com/api/v1/user_groups

Usage examples

curl https://yourZulipDomain.zulipchat.com/api/v1/user_groups \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY
#!/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)

Arguments

This endpoint does not consume any arguments.

Response

Return values

  • user_groups: A list of dictionaries, where each dictionary contains information about a user group.
    • description: The human-readable description of the user group.
    • id: The user group's integer id.
    • members: The integer User IDs of the user group members.
    • name: User group name.

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "user_groups": [
        {
            "description": "Characters of Hamlet",
            "id": 1,
            "members": [
                3,
                4
            ],
            "name": "hamletcharacters"
        },
        {
            "description": "Other users",
            "id": 2,
            "members": [
                1,
                2
            ],
            "name": "other users"
        }
    ]
}