Get subscription status
Check whether a user is subscribed to a stream.
GET https://society4.zulip.yocto.eu/api/v1/users/{user_id}/subscriptions/{stream_id}
Changes: New in Zulip 3.0 (feature level 11).
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 stream.
user_id = 7
stream_id = 1
result = client.call_endpoint(
url=f"/users/{user_id}/subscriptions/{stream_id}",
method="GET",
)
print(result)
curl -sSX GET -G https://society4.zulip.yocto.eu/api/v1/users/12/subscriptions/1 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
user_id integer required in path
Example: 12
stream_id integer required in path
Example: 1
The ID of the stream to access.
Response
Return values
Example response
A typical successful JSON response may look like:
{
"is_subscribed": false,
"msg": "",
"result": "success"
}