Zulip channels API
The channels API from Zulip — 23 operation(s) for channels.
Zulip channels API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include channels. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 30 operations across 23 paths, and defines 35 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.
Requests are made against 5 base URLs: https://{subdomain}.zulipchat.com/api/v1, {server}/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zulip channels API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
BasicAuth— Basic authentication, with the user's email as the username, and the API key as the password. The API key can be fetched using the /fetchapikey or /devfetchapi…
Paths & Operations 30
Across 23 paths, the API surfaces 30 operations — 3 DELETE, 11 GET, 6 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 35
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Subscription (41 properties), BasicChannelBase (29 properties), ChannelFolder (8 properties), GroupSettingValueUpdate (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zulip 12
Other APIs Zulip publishes across the network.