Get channel subscribers

GET https://freedom.zulipchat.com/api/v1/streams/{stream_id}/members

Get all users subscribed to a channel.

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Get the subscribers to a channel. Note that `client.get_subscribers`
# takes a `stream` parameter with the channel's name and not the
# channel's ID.
result = client.get_subscribers(stream="python-test")
print(result)

curl -sSX GET -G https://freedom.zulipchat.com/api/v1/streams/1/members \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

Response

Return values

• subscribers: (integer)[]

  A list containing the IDs of all active users who are subscribed to the channel.

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.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "subscribers": [
        11,
        26
    ]
}

An example JSON response for when the requested channel does not exist, or where the user does not have permission to access the target channel:

{
    "code": "BAD_REQUEST",
    "msg": "Invalid channel ID",
    "result": "error"
}