Get subscription status

GET https://engula.zulipchat.com/api/v1/users/{user_id}/subscriptions/{stream_id}

Check whether a user is subscribed to a channel.

Changes: New in Zulip 3.0 (feature level 12).

Usage examples

#!/usr/bin/env python3

import zulip

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

# Check whether a user is a subscriber to a given channel.
result = client.call_endpoint(
    url=f"/users/{user_id}/subscriptions/{stream_id}",
    method="GET",
)
print(result)

curl -sSX GET -G https://engula.zulipchat.com/api/v1/users/12/subscriptions/1 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

Response

Return values

• is_subscribed: boolean

  Whether the user is 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:

{
    "is_subscribed": false,
    "msg": "",
    "result": "success"
}