Get subgroups of the user group


Get the subgroups of a user group.

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

Usage examples

curl -sSX GET -G \
    --data-urlencode direct_subgroup_only=true


user_group_id integer required in path

Example: 33

The ID of the target user group.

direct_subgroup_only boolean optional

Example: true

Whether to consider only direct subgroups of the user group or subgroups of subgroups also.

Defaults to false.


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": [