Get subgroups of the user group
GET https://mylogstage.connect.xfel.eu/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://mylogstage.connect.xfel.eu/api/v1/user_groups/33/subgroups \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode direct_subgroup_only=true
Parameters
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
.
Response
Return values
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
]
}