Zulip invites API
The invites API from Zulip — 5 operation(s) for invites.
Zulip invites API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include invites. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 6 operations across 5 paths, and defines 10 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 invites 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 6
Across 5 paths, the API surfaces 6 operations — 2 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Invite (9 properties), JsonResponseBase (1 property). 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.