GET https://cse1010sp20.zulip.engr.uconn.edu/api/v1/streams/{stream_id}
Fetch details for the stream with the ID stream_id.
Changes: New in Zulip 6.0 (feature level 132).
Usage examples
curl
curl -sSX GET -G https://cse1010sp20.zulip.engr.uconn.edu/api/v1/streams/1 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
stream_idintegerrequired in path
Example: 1
The ID of the stream to access.
Response
Return values
stream: object
Object containing basic details about the stream.
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.
Changes: New in Zulip 2.1.0.
stream_post_policy: integer
Policy for which users can post messages to the stream.
Changes: New in Zulip 3.0 (feature level 1), replacing the previous
is_announcement_only boolean.
message_retention_days: integer | null
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 | null
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.
Is null for streams with no message history.
Changes: New in Zulip 2.1.0.
is_announcement_only: boolean
Whether the given stream is announcement only or not.
Changes: Deprecated in Zulip 3.0 (feature level 1). Clients
should use stream_post_policy instead.
can_remove_subscribers_group: integer
ID of the user group whose members are allowed to unsubscribe others
from the stream.
Changes: Before Zulip 8.0 (feature level 197),
the can_remove_subscribers_group setting
was named can_remove_subscribers_group_id.
New in Zulip 6.0 (feature level 142).
stream_weekly_traffic: integer | null
The average number of messages sent to the stream per week, as
estimated based on recent weeks, rounded to the nearest integer.
If null, no information is provided on the average traffic.
This can be because the stream was recently created and there
is insufficient data to make an estimate, or because the server
wishes to omit this information for this client, this realm, or
this endpoint or type of event.
Changes: New in Zulip 8.0 (feature level 199). Previously, this
statistic was available only in subscription objects.
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported array.