mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 13:03:29 +00:00
929724e5e7
We now have a separate page for common error payloads, for example, the payload for when the client's API key is invalid. All error payloads that are presented on this page will be tested similarly to our other non-error sample fixtures.
1.9 KiB
1.9 KiB
Get all streams
Get all streams that the user has access to.
GET {{ api_url }}/v1/streams
Usage examples
- Python
- JavaScript
- curl
curl {{ api_url }}/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 {{ api_url }}/v1/streams?include_public=false \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
{generate_code_example|get-all-streams|example}
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
```js
const zulip = require('zulip-js');
// Download zuliprc-dev from your dev server const config = { zuliprc: 'zuliprc-dev', };
zulip(config).then((client) => { // Get all streams that the user has access to client.streams.retrieve().then(console.log); });
</div>
</div>
</div>
## Arguments
**Note**: The following arguments are all URL query parameters.
{generate_api_arguments_table|arguments.json|get-all-streams.md}
## Response
#### Return values
* `stream_id`: The unique ID of a stream.
* `name`: The name of a stream.
* `description`: A short description of a stream.
* `invite-only`: Specifies whether a stream is invite-only or not.
Only people who have been invited can access an invite-only stream.
#### Example response
A typical successful JSON response may look like:
{generate_code_example|get-all-streams|fixture}
An example of a JSON response for when the user is not authorized
to use the `include_all_active` parameter:
{ 'code':'BAD_REQUEST', 'result':'error', 'msg':'User not authorized for this query' }