Get user group members

GET https://mc-stan.zulipchat.com/api/v1/user_groups/{user_group_id}/members

Get the members of a user group.

Changes: New in Zulip 6.0 (feature level 127).

Usage examples

curl -sSX GET -G https://mc-stan.zulipchat.com/api/v1/user_groups/22/members \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode direct_member_only=false

Parameters

user_group_id integer required in path

Example: 22

The ID of the target user group.


direct_member_only boolean optional

Example: false

Whether to consider only the direct members of user group and not members of its subgroups. Default is False.


Response

Return values

  • members: (integer)[]

    A list containing the user IDs of members of the user group.

Example response

A typical successful JSON response may look like:

{
    "members": [
        10,
        12
    ],
    "msg": "",
    "result": "success"
}