Get a stream by ID
GET https://css2024.zulip.aalto.fi/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 -sSX GET -G https://css2024.zulip.aalto.fi/api/v1/streams/1 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
stream_id integer required in path
Example: 1
The ID of the stream to access.
Response
Return values
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.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success",
"stream": {
"can_remove_subscribers_group": 2,
"date_created": 1691057093,
"description": "A Scandinavian country",
"first_message_id": 1,
"history_public_to_subscribers": true,
"invite_only": false,
"is_announcement_only": false,
"is_web_public": false,
"message_retention_days": null,
"name": "Denmark",
"rendered_description": "<p>A Scandinavian country</p>",
"stream_id": 7,
"stream_post_policy": 1,
"stream_weekly_traffic": null
}
}
An example JSON response for when the stream ID is not valid:
{
"code": "BAD_REQUEST",
"msg": "Invalid stream ID",
"result": "error"
}