Get user group members

GET https://fediverse.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://fediverse.zulipchat.com/api/v1/user_groups/38/members \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode direct_member_only=false

Parameters

Response

Return values

• members: (integer)[]

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

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:

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