Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zulip mobile API

The mobile API from Zulip — 6 operation(s) for mobile.

Zulip mobile API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include mobile. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 12 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.

6 operations 6 paths 12 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Servers
https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1
http://localhost:9991/api/v1
http://{subdomain}.testserver/json
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Zulip mobile 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 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

mobile 6
POST
/mobile_push/test_notificationdeprecated
Send a test notification to mobile device(s)
test-notify body → 200400
POST
/mobile_push/e2ee/test_notification
Send an E2EE test notification to mobile device(s)
e2ee-test-notify body → 200400403502
POST
/mobile_push/register
Register E2EE push device
register-push-device body → 200400
POST
/remotes/push/e2ee/register
Register E2EE push device to bouncer
register-remote-push-device body → 200400403
POST
/register_client_device
Register a logged-in device
register-client-device → 200
POST
/remove_client_device
Remove a registered device
remove-client-device body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed is JsonResponseBase (1 property). Each schema is shown below with its type and property counts.

JsonSuccessBase
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…
JsonSuccess
PushNotificationAdminActionRequiredError
InternalBouncerServerError
InvalidRemotePushDeviceTokenError
IgnoredParametersUnsupported
array
An array of any parameters sent in the request that are not supported by the endpoint. See [error handling](/api/rest-error-handlingignored-parameters) documen…
JsonResponseBase
object
1 property
InvalidPushDeviceTokenError
FailedToConnectBouncerError
CodedError
NoActivePushDeviceError
CodedErrorBase

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-mobile-api-openapi.yml Raw ↑

Other APIs Zulip publishes across the network.

Zulip REST API
Zulip Events API
Zulip Webhooks
Zulip authentication API
Zulip bots API
Zulip channels API
Zulip drafts API
Zulip invites API
Zulip messages API
Zulip navigation_views API
Zulip real_time_events API
Zulip reminders API