GET /user_groups
Fetches all of the user groups in the organization.
!!! warn ""
**Note**: This endpoint is not available to
[guest users](/help/user-roles).
Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint.
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
include_deactivated_groups |
Boolean | No |
Whether to include deactivated user groups in the response. Changes: In Zulip 10.0 (feature level 294), renamed
New in Zulip 10.0 (feature level 290). Previously, deactivated user groups did not exist and thus would never be included in the response. 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.