Get all streams

Get all streams that the user has access to.

GET https://oscafrica.zulipchat.com/api/v1/streams

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Get all streams that the user has access to
result = client.get_streams()
# You may pass in one or more of the query parameters mentioned above
# as keyword arguments, like so:
result = client.get_streams(include_public=False)
print(result)

More examples and documentation can be found here.

const zulipInit = require("zulip-js");

// Pass the path to your zuliprc file here.
const config = { zuliprc: "zuliprc" };

(async () => {
    const client = await zulipInit(config);

    // Get all streams that the user has access to
    console.log(await client.streams.retrieve());
})();

curl -sSX GET -G https://oscafrica.zulipchat.com/api/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 -sSX GET -G https://oscafrica.zulipchat.com/api/v1/streams \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode include_public=false

Parameters

Note: The following parameters are all URL query parameters.

include_public boolean optional

Example: false

Include all public streams.

Defaults to true.


include_web_public boolean optional

Example: true

Include all web public streams.

Defaults to false.


include_subscribed boolean optional

Example: false

Include all streams that the user is subscribed to.

Defaults to true.


include_all_active boolean optional

Example: true

Include all active streams. The user must have administrative privileges to use this parameter.

Defaults to false.


include_default boolean optional

Example: true

Include all default streams for the user's realm.

Defaults to false.


include_owner_subscribed boolean optional

Example: true

If the user is a bot, include all streams that the bot's owner is subscribed to.

Defaults to false.


Response

Return values

  • streams: (object)[] A list of stream objects with details on the requested streams.

    • stream_id: integer The unique ID of the stream.

    • name: string The name of the stream.

    • description: string The short description of the stream in text/markdown format, intended to be used to prepopulate UI for editing a stream's description.

    • date_created: integer The UNIX timestamp for when the stream was created, in UTC seconds.

      Changes: New in Zulip 4.0 (feature level 30).

    • invite_only: boolean Specifies whether the stream is private or not. Only people who have been invited can access a private stream.

    • rendered_description: string The short description of the stream rendered as HTML, intended to be used when displaying the stream description in a UI.

      One should use the standard Zulip rendered_markdown CSS when displaying this content so that emoji, LaTeX, and other syntax work correctly. And any client-side security logic for user-generated message content should be applied when displaying this HTML as though it were the body of a Zulip message.

    • is_web_public: boolean Whether the stream has been configured to allow unauthenticated access to its message history from the web.

    • stream_post_policy: integer Policy for which users can post messages to the stream.

      • 1 => Any user can post.
      • 2 => Only administrators can post.
      • 3 => Only full members can post.
      • 4 => Only moderators can post.

      Changes: New in Zulip 3.0, replacing the previous is_announcement_only boolean.

    • message_retention_days: integer Number of days that messages sent to this stream will be stored before being automatically deleted by the message retention policy. There are two special values:

      • null, the default, means the stream will inherit the organization level setting.
      • -1 encodes retaining messages in this stream forever.

      Changes: New in Zulip 3.0 (feature level 17).

    • history_public_to_subscribers: boolean Whether the history of the stream is public to its subscribers.

      Currently always true for public streams (i.e. invite_only=False implies history_public_to_subscribers=True), but clients should not make that assumption, as we may change that behavior in the future.

    • first_message_id: integer The id of the first message in the stream.

      Intended to help clients determine whether they need to display UI like the "more topics" widget that would suggest the stream has older history that can be accessed.

      Null is used for streams with no message history.

    • is_announcement_only: boolean Whether the given stream is announcement only or not.

      Changes: Deprecated in Zulip 3.0 (feature level 1), use stream_post_policy instead.

    • is_default: boolean Whether the given stream is a default stream. Only returned if the include_default parameter is true.

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "streams": [
        {
            "description": "A Scandinavian country",
            "invite_only": false,
            "name": "Denmark",
            "stream_id": 1
        },
        {
            "description": "Yet another Italian city",
            "invite_only": false,
            "name": "Rome",
            "stream_id": 2
        },
        {
            "description": "Located in the United Kingdom",
            "invite_only": false,
            "name": "Scotland",
            "stream_id": 3
        },
        {
            "description": "A northeastern Italian city",
            "invite_only": false,
            "name": "Venice",
            "stream_id": 4
        },
        {
            "description": "A city in Italy",
            "invite_only": false,
            "name": "Verona",
            "stream_id": 5
        },
        {
            "description": "New stream for testing",
            "invite_only": false,
            "name": "new stream",
            "stream_id": 6
        }
    ]
}

An example JSON response for when the user is not authorized to use the include_all_active parameter (i.e. because they are not an organization administrator):

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