Usage examples

#!/usr/bin/env python3importzulip# Download ~/zuliprc-dev from your dev serverclient=zulip.Client(config_file="~/zuliprc-dev")# Get all streams that the user is subscribed toresult=client.list_subscriptions()print(result)

constzulip=require('zulip-js');// Download zuliprc-dev from your dev serverconstconfig={zuliprc:'zuliprc-dev',};zulip(config).then((client)=>{// Get all streams that the user is subscribed toclient.streams.subscriptions.retrieve().then(console.log);});

Arguments

This request takes no arguments.

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 private or not.
Only people who have been invited can access a private 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).