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

Get stream ID

{generate_api_description(/get_stream_id:get)}

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.

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)}