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.

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

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://hyperfoil.zulipchat.com/api/v1/user_groups \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

  • user_groups: A list of user_group objects, which contain a description, a name, their id and the list of members of the 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"
        }
    ]
}