GET https://contech.zulip.aalto.fi/api/v1/users/me/{stream_id}/topics
Get all topics the user has access to in a specific stream.
Note that for private streams with protected
history, the user will only have access to
topics of messages sent after they subscribed to the
stream. Similarly, a user's bot
will only have access to messages sent after the bot was subscribed to
the stream, instead of when the user subscribed.
Usage examples
Python
JavaScript
curl
#!/usr/bin/env python3importzulip# Pass the path to your zuliprc file here.client=zulip.Client(config_file="~/zuliprc")result=client.get_stream_topics(stream_id)print(result)
More examples and documentation can be found here.
constzulipInit=require("zulip-js");// Pass the path to your zuliprc file here.constconfig={zuliprc:"zuliprc"};(async()=>{constclient=awaitzulipInit(config);// Get all the topics in stream with ID 1console.log(awaitclient.streams.topics.retrieve({stream_id:1}));})();
curl -sSX GET -G https://contech.zulip.aalto.fi/api/v1/users/me/1/topics \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
stream_idintegerrequired in path
Example: 1
The ID of the stream to access.
Response
Return values
topics: (object)[]
An array of topic objects.
max_id: integer
The message ID of the last message sent to this topic.
name: string
The name of the topic.
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.
An example JSON response for when the user is attempting to fetch the topics
of a non-existing stream (or also a private stream they don't have access to):