GET /users/me/subscriptions

Get all channels that the user is subscribed to.

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Query parameters

Name Type Required Description

Name	Type	Required	Description
`include_subscribers`	String	No	Whether each returned channel object should include a `subscribers` field containing a list of the user IDs of its subscribers. Client apps supporting organizations with many thousands of users should not pass `true`, because the full subscriber matrix may be several megabytes of data. The `partial` value, combined with the `subscriber_count` and fetching subscribers for individual channels as needed, is recommended to support client app features where channel subscriber data is useful. If a client passes `partial` for this parameter, the server may, for some channels, return a subset of the channel's subscribers in the `partial_subscribers` field instead of the `subscribers` field, which always contains the complete set of subscribers. The server guarantees that it will always return a `subscribers` field for channels with fewer than 250 total subscribers. When returning a `partial_subscribers` field, the server guarantees that all bot users and users active within the last 14 days will be included. For other cases, the server may use its discretion to determine which channels and users to include, balancing between payload size and usefulness of the data provided to the client. Changes: The `partial` value is new in Zulip 11.0 (feature level 412). New in Zulip 2.1.0. Valid values: `"partial"` `"false"` `"true"` Default value: "false"

include_subscribers

String

Whether each returned channel object should include a subscribers field containing a list of the user IDs of its subscribers.

Client apps supporting organizations with many thousands of users should not pass true, because the full subscriber matrix may be several megabytes of data. The partial value, combined with the subscriber_count and fetching subscribers for individual channels as needed, is recommended to support client app features where channel subscriber data is useful.

If a client passes partial for this parameter, the server may, for some channels, return a subset of the channel's subscribers in the partial_subscribers field instead of the subscribers field, which always contains the complete set of subscribers.

The server guarantees that it will always return a subscribers field for channels with fewer than 250 total subscribers. When returning a partial_subscribers field, the server guarantees that all bot users and users active within the last 14 days will be included. For other cases, the server may use its discretion to determine which channels and users to include, balancing between payload size and usefulness of the data provided to the client.

Changes: The partial value is new in Zulip 11.0 (feature level 412).

New in Zulip 2.1.0.

Valid values:

"partial"
"false"
"true"

Default value: "false"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.