zulip/templates/zerver/api/get-stream-topics.md

58 lines
1.3 KiB
Markdown
Raw Normal View History

# Get topics in a stream
{generate_api_description(/users/me/{stream_id}/topics:get)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/users/me/{stream_id}/topics:get|example}
{tab|js}
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
```js
const zulip = require('zulip-js');
// Pass the path to your zuliprc file here.
const config = {
zuliprc: 'zuliprc',
};
zulip(config).then((client) => {
// Get all the topics in stream with ID 1
return client.streams.topics.retrieve({ stream_id: 1 });
}).then(console.log);
```
{tab|curl}
{generate_code_example(curl)|/users/me/{stream_id}/topics:get|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/users/me/{stream_id}/topics:get}
## Response
#### Return values
* `topics`: An array of `topic` objects, which contain:
* `name`: The name of the topic.
* `max_id`: The message ID of the last message sent to this topic.
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/users/me/{stream_id}/topics:get|fixture(200)}
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):
{generate_code_example|/users/me/{stream_id}/topics:get|fixture(400)}