GET /user_groups/{user_group_id}/subgroups
Get the subgroups of a user group.
Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint.
New in Zulip 6.0 (feature level 127).
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_group_id |
Integer | Yes |
The ID of the target user group. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
direct_subgroup_only |
Boolean | No |
Whether to consider only direct subgroups of the user group or subgroups of subgroups also. Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.