Get subgroups of a user group

GET https://chat.zulip.org/api/v1/user_groups/{user_group_id}/subgroups

Get the subgroups of a user group.

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

Usage examples

curl -sSX GET -G https://chat.zulip.org/api/v1/user_groups/38/subgroups \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode direct_subgroup_only=true

Parameters

Response

Return values

• subgroups: (integer)[]

  A list containing the IDs of subgroups 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:

{
    "msg": "",
    "result": "success",
    "subgroups": [
        2,
        3
    ]
}