zulip/templates/zerver/api/get-all-streams.md

Get all streams

Get all streams that the user has access to.

GET {{ api_url }}/v1/streams

Usage examples

• Python
• JavaScript
• curl

curl {{ api_url }}/v1/streams -u BOT_EMAIL_ADDRESS:BOT_API_KEY

You may pass in one or more of the parameters mentioned above as URL query parameters, like so:

curl {{ api_url }}/v1/streams?include_public=false \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

#!/usr/bin/env python

import zulip

# Download ~/zuliprc-dev from your dev server
client = zulip.Client(config_file="~/zuliprc-dev")

# Get all streams that the user has access to
print(client.get_streams())

# You may pass in one or more of the query parameters mentioned above
# as keyword arguments, like so:
print(client.get_streams(include_public=False))

More examples and documentation can be found [here](https://github.com/zulip/zulip-js). ```js const zulip = require('zulip-js');

// Download zuliprc-dev from your dev server const config = { zuliprc: 'zuliprc-dev', };

zulip(config).then((client) => { // Get all streams that the user has access to client.streams.retrieve().then(console.log); });

</div>

</div>

</div>

## Arguments

**Note**: The following arguments are all URL query parameters.

{generate_api_arguments_table|arguments.json|get-all-streams.md}

## Response

#### Return values

* `stream_id`: The unique ID of a stream.
* `name`: The name of a stream.
* `description`: A short description of a stream.
* `invite-only`: Specifies whether a stream is invite-only or not.
  Only people who have been invited can access an invite-only stream.

#### Example response

A typical successful JSON response may look like:

{ 'result':'success', 'streams':[ { 'stream_id':15, 'name':'Denmark', 'invite_only':False, 'description':'A Scandinavian country' }, { 'stream_id':16, 'name':'Rome', 'invite_only':False, 'description':'Yet another Italian city' }, { 'stream_id':17, 'name':'Scotland', 'invite_only':False, 'description':'Located in the United Kingdom' }, { 'stream_id':18, 'name':'Venice', 'invite_only':False, 'description':'A northeastern Italian city' }, { 'stream_id':19, 'name':'Verona', 'invite_only':False, 'description':'A city in Italy' } ], 'msg':'' }

An example of a JSON response for when the user is not authorized
to use the `include_all_active` parameter:

{ 'code':'BAD_REQUEST', 'result':'error', 'msg':'User not authorized for this query' }

{!invalid-api-key-json-response.md!}