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

58 lines
1.1 KiB
Markdown
Raw Normal View History

# Get stream ID
Get the unique ID of a given stream.
`GET {{ api_url }}/v1/get_stream_id`
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/get_stream_id: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 the ID of a given stream
client.streams.getStreamId('Denmark').then(console.log);
});
```
{tab|curl}
{generate_code_example(curl)|/get_stream_id:get|example}
{end_tabs}
## Arguments
**Note**: The following arguments are all URL query parameters.
{generate_api_arguments_table|zulip.yaml|/get_stream_id:get}
## Response
#### Return values
* `stream_id`: The ID of the given stream.
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/get_stream_id:get|fixture(200)}
An example JSON response for when the supplied stream does not exist:
{generate_code_example|/get_stream_id:get|fixture(400)}