GET /streams

Get all channels that the user has access to.

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Query parameters

Name	Type	Required	Description
`include_web_public`	Boolean	No	Include all web-public channels. Default value: false
`include_owner_subscribed`	Boolean	No	If the user is a bot, include all channels that the bot's owner is subscribed to. Default value: false
`include_all`	Boolean	No	Include all channels that the user has metadata access to. For organization administrators, this will be all channels in the organization, since organization administrators implicitly have metadata access to all channels. Changes: New in Zulip 10.0 (feature level 356). On older versions, use `include_all_active`, which this replaces. Default value: false
`include_public`	Boolean	No	Include all public channels. Default value: true
`exclude_archived`	Boolean	No	Whether to exclude archived streams from the results. Changes: New in Zulip 10.0 (feature level 315). Default value: true
`include_can_access_content`	Boolean	No	Include all the channels that the user has content access to. Changes: New in Zulip 10.0 (feature level 356). Default value: false
`include_subscribed`	Boolean	No	Include all channels that the user is subscribed to. Default value: true
`include_all_active`	Boolean	No	Deprecated parameter to include all channels. The user must have administrative privileges to use this parameter. Changes: Deprecated in Zulip 10.0 (feature level 356). Clients interacting with newer servers should use the equivalent `include_all` parameter, which does not incorrectly hint that this parameter, and not `exclude_archived`, controls whether archived channels appear in the response. Default value: false
`include_default`	Boolean	No	Include all default channels for the user's realm. 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.