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 server_and_organizations API

The server_and_organizations API from Zulip — 16 operation(s) for server_and_organizations.

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

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

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

24 operations 16 paths 16 schemas 4 DELETE8 GET5 PATCH7 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 server_and_organizations 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 24

Across 16 paths, the API surfaces 24 operations — 4 DELETE, 8 GET, 5 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

server_and_organizations 24
POST
/realm/emoji/{emoji_name}
Upload custom emoji
upload-custom-emoji 1 param body → 200
DELETE
/realm/emoji/{emoji_name}
Deactivate custom emoji
deactivate-custom-emoji 1 param → 200404
GET
/realm/emoji
Get all custom emoji
get-custom-emoji → 200
GET
/realm/presence
Get presence of all users
get-presence → 200
GET
/realm/domains
Get allowed domains
get-realm-domains → 200
POST
/realm/domains
Add an allowed domain
add-realm-domain body → 200
PATCH
/realm/domains/{domain}
Update an allowed domain
patch-realm-domain 1 param body → 200
DELETE
/realm/domains/{domain}
Remove an allowed domain
delete-realm-domain 1 param → 200
GET
/realm/profile_fields
Get all custom profile fields
get-custom-profile-fields → 200
PATCH
/realm/profile_fields
Reorder custom profile fields
reorder-custom-profile-fields body → 200
POST
/realm/profile_fields
Create a custom profile field
create-custom-profile-field body → 200
PATCH
/realm/user_settings_defaults
Update realm-level defaults of user settings
update-realm-user-settings-defaults body → 200
GET
/realm/linkifiers
Get linkifiers
get-linkifiers → 200
PATCH
/realm/linkifiers
Reorder linkifiers
reorder-linkifiers body → 200
POST
/realm/filters
Add a linkifier
add-linkifier body → 200
DELETE
/realm/filters/{filter_id}
Remove a linkifier
remove-linkifier 1 param → 200
PATCH
/realm/filters/{filter_id}
Update a linkifier
update-linkifier 1 param body → 200
POST
/realm/playgrounds
Add a code playground
add-code-playground body → 200
DELETE
/realm/playgrounds/{playground_id}
Remove a code playground
remove-code-playground 1 param → 200
GET
/export/realm
Get all data exports
get-realm-exports → 200
POST
/export/realm
Create a data export
export-realm body → 200400
GET
/export/realm/consents
Get data export consent state
get-realm-export-consents → 200
POST
/realm/test_welcome_bot_custom_message
Test welcome bot custom message
test-welcome-bot-custom-message body → 200
GET
/server_settings
Get server settings
get-server-settings → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CustomProfileField (10 properties), RealmExport (8 properties), RealmEmoji (6 properties), LegacyPresenceFormat (4 properties). 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…
CustomProfileField
object
Dictionary containing the details of a custom profile field configured for this organization.
10 properties 7 required
RealmExport
object
Object containing details about a [data export](/help/export-your-organization).
8 properties
EmailAddressVisibility
integer
The [policy][permission-level] for [which other users][help-email-visibility] in this organization can see the user's real email address. - 1 = Everyone - 2 =…
JsonSuccess
IgnoredParametersSuccess
Changes: The [ignoredparametersunsupported][ignoredparams] array was added as a possible return value for all REST API endpoint JSON success responses in Zulip…
IgnoredParametersBase
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…
CodedErrorBase
JsonResponseBase
object
1 property
RealmDomain
object
2 properties 2 required
LinkifierPattern
string
The [Python regular expression](https://docs.python.org/3/howto/regex.html) that should trigger the linkifier.
LinkifierURLTemplate
string
The [RFC 6570](https://www.rfc-editor.org/rfc/rfc6570.html) compliant URL template used for the link. If you used named groups in pattern, you can insert their…
CodedError
RealmEmoji
object
Object containing details about an emoji. It has the following properties:
6 properties
LegacyPresenceFormat
object
{clientname} or "aggregated": Object containing the details of the user's presence. Changes: Starting with Zulip 7.0 (feature level 178), this will always cont…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-server-and-organizations-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 mobile API
Zulip navigation_views API
Zulip real_time_events API