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

# Get subscribed streams

Get all streams that the user is subscribed to.

`GET {{ api_url }}/v1/users/me/subscriptions`

## Arguments

This request takes no arguments.

## Usage examples
<div class="code-section" markdown="1">
<ul class="nav">
<li data-language="curl">curl</li>
<li data-language="python">Python</li>
<li data-language="javascript">JavaScript</li>
</ul>
<div class="blocks">

<div data-language="curl" markdown="1">

```
curl {{ api_url }}/v1/users/me/subscriptions \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY
```

</div>

<div data-language="python" markdown="1">

```python
#!/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 is subscribed to
print(client.list_subscriptions())
```
</div>

<div data-language="javascript" markdown="1">
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).

```js
const zulip = require('zulip-js');

const config = {
  username: 'othello-bot@example.com',
  apiKey: 'a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5',
  realm: '{{ api_url }}'
};

const client = zulip(config);

// Get all streams that the user is subscribed to
client.streams.subscriptions.retrieve().then(res => {
  console.log(res);
});

```
</div>

</div>

</div>

## Response

#### Return values

* `subscriptions`: A list of dictionaries where each dictionary contains
  information about one of the subscribed streams.
    * `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.
    * `subscribers`: A list of email addresses of users who are also subscribed
      to a given stream.
    * `desktop_notifications`: A boolean specifiying whether desktop notifications
      are enabled for the given stream.
    * `push_notifications`: A boolean specifiying whether push notifications
      are enabled for the given stream.
    * `audible_notifications`: A boolean specifiying whether audible notifications
      are enabled for the given stream.
    * `pin_to_top`: A boolean specifying whether the given stream has been pinned
      to the top.
    * `email_address`: Email address of the given stream.
    * `in_home_view`: Whether the given stream is muted or not. Muted streams do
      not count towards your total unread count and thus, do not show up in
      `All messages` view (previously known as `Home` view).
    * `color`: Stream color.

#### Example response

A typical successful JSON response may look like:

```
{
    'result':'success',
    'subscriptions':[
        {
            'desktop_notifications':False,
            'pin_to_top':False,
            'subscribers':[
                'ZOE@zulip.com',
                'hamlet@zulip.com',
                'iago@zulip.com',
                'othello@zulip.com',
                'prospero@zulip.com',
                'sample-bot@localhost'
            ],
            'invite_only':True,
            'email_address':'Denmark+cb16118453aa4e76cb36e394a153a1a3@zulipdev.com:9991',
            'name':'Denmark',
            'color':'#76ce90',
            'description':'A Scandinavian country',
            'in_home_view':True,
            'push_notifications':False,
            'stream_id':15,
            'audible_notifications':False
        },
        {
            'desktop_notifications':False,
            'pin_to_top':False,
            'subscribers':[
                'ZOE@zulip.com',
                'iago@zulip.com',
                'othello@zulip.com',
                'prospero@zulip.com',
                'sample-bot@localhost'
            ],
            'invite_only':False,
            'email_address':'Scotland+463ab6b458e2d0364aab52ca55b70ffb@zulipdev.com:9991',
            'name':'Scotland',
            'color':'#fae589',
            'description':'Located in the United Kingdom',
            'in_home_view':True,
            'push_notifications':False,
            'stream_id':17,
            'audible_notifications':False
        }
    ],
    'msg':''
}
```

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