Zulip REST API
Powerful open source group chat
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Powerful open source group chat
Endpoints 167
authentication
- POSTFetch an API key (production)
/fetch_api_keyThis API endpoint is used by clients such as the Zulip mobile and terminal apps to implement password-based authentication. Given the user's Zulip login… - POSTFetch an API key (JWT)
/jwt/fetch_api_keyThis API endpoint is used by clients to implement JSON Web Token (JWT) authentication. Given a JWT identifying a Zulip user, it returns a Zulip API key that… - POSTFetch an API key (development only)
/dev_fetch_api_keyFor easy testing of mobile apps and other clients and against Zulip development servers, we support fetching a Zulip API key for any user on the development… - GETList users (development only)
/dev_list_usersGet a list of all, non-bot users in a Zulip development server. This endpoint is used by mobile developers to fetch users for the development login flow. !!!…
real_time_events
- GETGet events from an event queue
/events?queue_id=fb67bf8a-c031-47cc-84cf-ed80accacda8&last_event_id=-1&dont_block=trueThis endpoint allows you to receive new events from a registered event queue. Long-lived clients should use the event_queue_longpoll_timeout_seconds property… - DELETEDelete an event queue
/eventsDelete a previously registered queue. - POSTRegister an event queue
/registerThis powerful endpoint can be used to register a Zulip "event queue" (subscribed to certain types of "events", or updates to the messages and other Zulip data… - POSTPOST /real-time
/real-time(Ignored) - POSTError handling
/rest-error-handlingCommon error to many endpoints
channels
- GETGet channel ID
/get_stream_id?stream=DenmarkGet the unique ID of a given channel. - POSTAdd a default channel
/default_streamsAdd a channel to the set of [default channels][default-channels] for new users joining the organization. [default-channels]:… - DELETERemove a default channel
/default_streamsRemove a channel from the set of [default channels][default-channels] for new users joining the organization. [default-channels]:… - GETGet topics in a channel
/users/me/:stream_id/topics?allow_empty_topic_name=trueGet all topics the user has access to in a specific channel. Note that for private channels with protected history, the user will only have access to topics… - GETGet subscribed channels
/users/me/subscriptions?include_subscribers=trueGet all channels that the user is subscribed to. - POSTSubscribe to a channel
/users/me/subscriptionsSubscribe one or more users to one or more channels. If any of the specified channels do not exist, they are automatically created. The initial channel… - DELETEUnsubscribe from a channel
/users/me/subscriptionsUnsubscribe yourself or other users from one or more channels. In addition to managing the current user's subscriptions, this endpoint can be used to remove… - PATCHTopic muting
/users/me/subscriptions/muted_topicsDeprecated. Mute or unmute a topic within a channel that the current user is subscribed to. Changes: Deprecated in Zulip 7.0 (feature level 170). Clients… - POSTUpdate personal preferences for a topic
/user_topicsThis endpoint is used to update the personal preferences for a topic, such as the topic's visibility policy, which is used to implement mute a topic and… - GETGet subscription status
/users/:user_id/subscriptions/:stream_idCheck whether a user is subscribed to a channel. Changes: Prior to Zulip 12.0 (feature level 458), this endpoint did not support querying subscriptions of bot… - GETGet a user's subscribed channels
/users/:user_id/channelsGets the list of channels that the target user is subscribed to. The channel security model means only those subscribed channels to which the acting user has… - POSTBulk update subscription settings
/users/me/subscriptions/propertiesUpdate the current user's personal settings for channels they are subscribed to. These settings include color, muting, pinning and per-channel notification… - PATCHUpdate a subscription setting
/users/me/subscriptions/:stream_idUpdate the current user's personal settings for a specific channel they are subscribed to. These settings include color, muting, pinning and per-channel… - GETGet channel subscribers
/streams/:stream_id/membersGet all users subscribed to a channel. Changes: Before Zulip 12.0 (feature level 480), this endpoint was not supported for archived channels. - GETGet all channels
/streams?include_public=false&include_web_public=true&include_subscribed=false&exclude_archived=true&include_all_active=true&include_all=true&include_default=true&include_owner_subscribed=true&include_can_access_content=trueGet all channels that the user has access to. - GETGet a channel by ID
/streams/:stream_idFetch details for the channel with the ID stream_id. Changes: Before Zulip 12.0 (feature level 480), this endpoint was not supported for archived channels.… - DELETEArchive a channel
/streams/:stream_idArchive the channel with the ID stream_id. - PATCHUpdate a channel
/streams/:stream_idConfigure the channel with the ID stream_id. This endpoint supports an organization administrator editing any property of a channel, including: Channel name… - GETGet channel's email address
/streams/:stream_id/email_address?sender_id=1Get email address of a channel. Note that only users with permission to post messages in the channel can access the channel's email address. Changes: Prior to… - POSTDelete a topic
/streams/:stream_id/delete_topicDelete all messages in a topic. Topics are a field on messages (not an independent data structure), so deleting all the messages in the topic deletes the… - POSTCreate a channel
/channels/createCreate a new channel, and optionally subscribe users to the newly created channel. The initial channel settings will be determined by the optional parameters,… - POSTCreate a channel folder
/channel_folders/createCreate a new channel folder. Changes: New in Zulip 11.0 (feature level 389). - GETGet channel folders
/channel_foldersFetches all of the channel folders in the organization, sorted by the order field. Changes: Before Zulip 11.0 (feature level 414), the list of channel folders… - PATCHReorder channel folders
/channel_foldersReorder the channel folders in the user's organization. Channel folders are displayed in Zulip UI in order; this endpoint allows administrative settings UI to… - PATCHUpdate a channel folder
/channel_folders/:channel_folder_idUpdate the name or description of a channel folder with the specified ID. This endpoint is also used to archive or unarchive the specified channel folder.… - GETCreate BigBlueButton video call
/calls/bigbluebutton/create?meeting_name=test_channel meeting&voice_only=trueCreate a video call URL for a BigBlueButton video call. Requires BigBlueButton 2.4+ to be configured on the Zulip server. The acting user will be given the… - POSTCreate Nextcloud Talk video call
/calls/nextcloud_talk/createCreate a video call URL for a Nextcloud Talk video call. Requires Nextcloud Talk to be configured on the Zulip server. Changes: New in Zulip 12.0 (feature… - POSTCreate Webex video call
/calls/webex/createCreate a video call URL for a Webex video call. Requires Webex integration to be configured on the Zulip server. Clients should confirm that the user has… - POSTCreate Google Meet video call
/calls/google_meet/createCreate a video call URL for a Google Meet video call. Requires the Google Meet integration to be configured on the Zulip server. Clients should confirm that… - POSTCreate Constructor Groups video call
/calls/constructorgroups/createCreate a video call URL for a Constructor Groups video call. Requires Constructor Groups to be configured on the Zulip server. Changes: New in Zulip 12.0…
messages
- POSTMark all messages as read
/mark_all_as_readDeprecated. Marks all of the current user's unread messages as read. Because this endpoint marks messages as read in batches, it is possible for the request… - POSTMark messages in a channel as read
/mark_stream_as_readDeprecated. Mark all the unread messages in a channel as read. Changes: Deprecated; clients should use the update personal message flags for narrow endpoint… - POSTMark messages in a topic as read
/mark_topic_as_readDeprecated. Mark all the unread messages in a topic as read. Changes: Deprecated; clients should use the update personal message flags for narrow endpoint… - GETGet messages
/messages?anchor=43&include_anchor=false&anchor_date=2005-04-18T12:34:56Z&num_before=4&num_after=8&narrow=&client_gravatar=false&apply_markdown=false&use_first_unread_anchor=true&message_ids=&allow_empty_topic_name=trueThis endpoint is the primary way to fetch messages. It is used by all official Zulip clients (e.g. the web, desktop, mobile, and terminal clients) as well as… - POSTSend a message
/messagesSend a channel message or a direct message. - GETGet a message's edit history
/messages/:message_id/history?allow_empty_topic_name=trueFetch the message edit history of a previously edited message. Note that edit history may be disabled in some organizations; see the [Zulip help center… - POSTUpdate personal message flags
/messages/flagsAdd or remove personal message flags like read and starred on a collection of message IDs. See also the endpoint for updating flags on a range of messages… - POSTUpdate personal message flags for narrow
/messages/flags/narrowAdd or remove personal message flags like read and starred on a range of messages within a narrow. See also the endpoint for updating flags on specific… - POSTRender a message
/messages/renderRender a message to HTML. - POSTAdd an emoji reaction
/messages/:message_id/reactionsAdd an emoji reaction to a message. - DELETERemove an emoji reaction
/messages/:message_id/reactionsRemove an emoji reaction from a message. - GETGet a message's read receipts
/messages/:message_id/read_receiptsReturns a list containing the IDs for all users who have marked the message as read (and whose privacy settings allow sharing that information). The list of… - GETCheck if messages match a narrow
/messages/matches_narrow?msg_ids=&narrow=Check whether a set of messages match a narrow. For many common narrows (e.g. a topic), clients can write an efficient client-side check to determine whether… - GETFetch a single message
/messages/:message_id?apply_markdown=false&allow_empty_topic_name=trueGiven a message ID, return the message object. Additionally, a raw_content field is included. This field is useful for clients that primarily work with… - DELETEDelete a message
/messages/:message_idPermanently delete a message. This API corresponds to the [delete a message completely][delete-completely] feature documented in the Zulip help center. A user… - PATCHEdit a message
/messages/:message_idUpdate the content, topic, or channel of the message with the specified ID. You can resolve topics by editing the topic to ✔ {original_topic} with the… - POSTReport a message
/messages/:message_id/reportSends a notification to the organization's moderation request channel, if it is configured, that reports the targeted message for review and moderation.… - POSTUpload a file
/user_uploadsUpload a single file and get the corresponding URL. Initially, only you will be able to access the link. To share the uploaded file, you'll need to [send a… - GETCheck thumbnail status
/thumbnail/status/:realm_id_str/:filenameCheck whether a thumbnail exists for a specific file uploaded by a user. This endpoint is intended to be polled by clients to determine when thumbnail… - GETGet public temporary URL for an uploaded file
/user_uploads/:realm_id_str/:filenameGet a temporary URL for access to an uploaded file that doesn't require authentication. The SIGNED_ACCESS_TOKEN_VALIDITY_IN_SECONDS server setting controls…
users
- GETGet attachments
/attachmentsFetch metadata on files uploaded by the requesting user. - DELETEDelete an attachment
/attachments/:attachment_idDelete an uploaded file given its attachment ID. Note that uploaded files that have been referenced in at least one message are automatically deleted once the… - GETGet users
/users?client_gravatar=false&include_custom_profile_fields=true&user_ids=Retrieve details on users in the organization. By default, returns all accessible users in the organization. The user_ids query parameter can be used to limit… - POSTCreate a user
/usersCreate a new user account via the API. !!! warn "" Note: On Zulip Cloud, this feature is available only for organizations on a Zulip Cloud Standard or Zulip… - POSTReactivate a user
/users/:user_id/reactivateReactivates a user given their user ID. If the user is a bot whose owner is deactivated, the acting user becomes the bot's owner, and the bot's API key is… - GETGet a user's status
/users/:user_id/statusGet the status currently set by a user in the organization. Changes: New in Zulip 9.0 (feature level 262). Previously, user statuses could only be fetched via… - POSTUpdate user status
/users/:user_id/statusAdministrator endpoint for changing the status of another user. Changes: Prior to Zulip 12.0 (feature level 473), only bots could not access this API… - GETGet a user's presence
/users/:user_id_or_email/presenceGet the presence status for a specific user. This endpoint is most useful for embedding data about a user's presence status in other sites (e.g. an employee… - GETGet own user
/users/meGet basic data about the user/bot that requests this endpoint. Changes: Removed is_billing_admin field in Zulip 10.0 (feature level 363), as it was replaced… - DELETEDeactivate own user
/users/meDeactivates the current user's account. See also the administrative endpoint for deactivating another user. This endpoint is primarily useful to Zulip clients… - POSTRegenerate your API key
/users/me/api_key/regenerate!!! warn "" Note: Users should treat their Zulip API key as carefully as they would their password. Generate a new API key for the user making the request.… - GETGet all alert words
/users/me/alert_wordsGet all of the user's configured [alert words][alert-words]. [alert-words]: /help/dm-mention-alert-notifications#alert-words - POSTAdd alert words
/users/me/alert_wordsAdd words (or phrases) to the user's set of configured [alert words][alert-words]. [alert-words]: /help/dm-mention-alert-notifications#alert-words - DELETERemove alert words
/users/me/alert_wordsRemove words (or phrases) from the user's set of configured [alert words][alert-words]. Alert words are case insensitive. [alert-words]:… - POSTUpdate your presence
/users/me/presenceUpdate the current user's [presence][availability] and fetch presence data of other users in the organization. This endpoint is meant to be used by clients… - DELETERemove your profile data
/users/me/profile_dataRemove the current user's profile data for one or more of the custom profile fields configured in the organization. - PATCHUpdate your profile data
/users/me/profile_dataUpdate the current user's profile data for one or more of the custom profile fields configured in the organization. - POSTUpdate your status
/users/me/statusChange your status. A request to this endpoint will only change the parameters passed. For example, passing just status_text requests a change in the status… - POSTMute a user
/users/me/muted_users/:muted_user_idMute a user from the perspective of the requesting user. Messages sent by muted users will be automatically marked as read and hidden for the user who muted… - DELETEUnmute a user
/users/me/muted_users/:muted_user_idUnmute a user from the perspective of the requesting user. Changes: New in Zulip 4.0 (feature level 48). - POSTAdd an APNs device token
/users/me/apns_device_tokenDeprecated. This endpoint adds an APNs device token to register for iOS push notifications. Changes: Deprecated in Zulip 11.0 (feature level 406). Clients… - DELETERemove an APNs device token
/users/me/apns_device_tokenDeprecated. This endpoint removes an APNs device token for iOS push notifications. Changes: Deprecated in Zulip 11.0 (feature level 406) and will be removed… - POSTAdd an FCM registration token
/users/me/android_gcm_reg_idDeprecated. This endpoint adds an FCM registration token for push notifications. Changes: Deprecated in Zulip 11.0 (feature level 406). Clients connecting to… - DELETERemove an FCM registration token
/users/me/android_gcm_reg_idDeprecated. This endpoint removes an FCM registration token for push notifications. Changes: Deprecated in Zulip 11.0 (feature level 406) and will be removed… - POSTUpload your profile picture
/users/me/avatarUpload a new profile picture for the current user. The maximum allowed file size is available in the max_avatar_file_size_mib field in the POST /register… - DELETEDelete your profile picture
/users/me/avatarDelete the current user's uploaded profile picture, reverting to the organization's default style for profile pictures. This endpoint is idempotent: if the… - GETGet a user by email
/users/:email?client_gravatar=false&include_custom_profile_fields=trueFetch details for a single user in the organization given a Zulip API email address. You can also fetch details on all users in the organization or by user… - PATCHUpdate a user by email
/users/:emailAdministrative endpoint to update the details of another user in the organization by their email address. Works the same way as PATCH /users/{user_id} but… - GETGet a user
/users/:user_id?client_gravatar=false&include_custom_profile_fields=trueFetch details for a single user in the organization. You can also fetch details on all users in the organization or by a user's Zulip API email. Changes: In… - DELETEDeactivate a user
/users/:user_id?actions=Deactivates a user given their user ID. Note that any bots controlled by the user will be deactivated before the user; clients that don't want this behavior… - PATCHUpdate a user
/users/:user_idAdministrative endpoint to update the details of another user in the organization. Supports everything an administrator can do to edit details of another… - PATCHUpdate settings
/settingsThis endpoint is used to edit the current user's settings. When invoked by a realm admin, it supports bulk updates to settings for specified users or members… - POSTSet "typing" status
/typingNotify other users whether the current user is [typing a message][help-typing]. Clients implementing Zulip's typing notifications protocol should work as… - POSTSet "typing" status for message editing
/messages/:message_id/typingNotify other users whether the current user is editing a message. Typing notifications for editing messages follow the same protocol as set-typing-status, see… - POSTCreate a user group
/user_groups/createCreate a new user group. Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint. - GETGet user group members
/user_groups/:user_group_id/members?direct_member_only=falseGet the members of a user group. Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint. New in Zulip 6.0… - POSTUpdate user group members
/user_groups/:user_group_id/membersUpdate the members of a user group. The user IDs must correspond to non-deactivated users. Changes: Prior to Zulip 12.0 (feature level 496), bot users were… - PATCHUpdate a user group
/user_groups/:user_group_idUpdate the name, description or any of the permission settings of a user group. This endpoint is also used to reactivate a user group. Note that while… - GETGet user groups
/user_groupsFetches all of the user groups in the organization. !!! warn "" Note: This endpoint is not available to guest users. Changes: Prior to Zulip 12.0 (feature… - GETGet subgroups of a user group
/user_groups/:user_group_id/subgroups?direct_subgroup_only=trueGet the subgroups of a user group. Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint. New in Zulip 6.0… - POSTUpdate subgroups of a user group
/user_groups/:user_group_id/subgroupsUpdate the subgroups of a user group. Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint. Prior to Zulip… - GETGet user group membership status
/user_groups/:user_group_id/members/:user_id?direct_member_only=falseCheck whether a user is member of user group. Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint. Prior to… - POSTDeactivate a user group
/user_groups/:user_group_id/deactivateDeactivate a user group. Deactivated user groups cannot be used for mentions, permissions, or any other purpose, but can be reactivated or renamed.… - GETGet a bot's API key
/bots/:bot_id/api_keyFetch the API key for a bot user. Only the bot's owner and organization administrators have access to a bot's API key. Changes: New in Zulip 12.0 (feature… - POSTRegenerate a bot's API key
/bots/:bot_id/api_key/regenerateGenerate a new API key for a bot user. Only the bot's owner and organization administrators have access to a bot's API key.
bots
- GETGet a bot's stored data
/bot_storage?keys=!!! warn "" Note: This endpoint is only available to bot user accounts. Retrieve data stored for a bot user. Changes: Prior to Zulip 12.0 (feature level 494),… - PUTUpdate a bot's stored data
/bot_storage!!! warn "" Note: This endpoint is only available to bot user accounts. Add or update data stored for a bot user. Each bot has a limited storage set by the… - DELETERemove a bot's stored data
/bot_storage!!! warn "" Note: This endpoint is only available to bot user accounts. Delete data stored for a bot user. Changes: Prior to Zulip 12.0 (feature level 494),…
drafts
- GETGet drafts
/draftsFetch all drafts for the current user. - POSTCreate drafts
/draftsCreate one or more drafts on the server. These drafts will be automatically synchronized to other clients via drafts events. - DELETEDelete a draft
/drafts/:draft_idDelete a single draft from the server. The deletion will be automatically synchronized to other clients via a drafts event. - PATCHEdit a draft
/drafts/:draft_idEdit a draft on the server. The edit will be automatically synchronized to other clients via drafts events. - GETGet all saved snippets
/saved_snippetsFetch all the saved snippets for the current user. Changes: New in Zulip 10.0 (feature level 297). - POSTCreate a saved snippet
/saved_snippetsCreate a new saved snippet for the current user. Changes: New in Zulip 10.0 (feature level 297). - DELETEDelete a saved snippet
/saved_snippets/:saved_snippet_idDelete a saved snippet. Changes: New in Zulip 10.0 (feature level 297). - PATCHEdit a saved snippet
/saved_snippets/:saved_snippet_idEdit a saved snippet for the current user. Changes: New in Zulip 10.0 (feature level 368).
navigation_views
- GETGet all navigation views
/navigation_viewsFetch all configured custom navigation views for the current user. Changes: New in Zulip 11.0 (feature level 390). - POSTAdd a navigation view
/navigation_viewsAdds a new custom left sidebar navigation view configuration for the current user. This can be used both to configure built-in navigation views, or to add new… - DELETERemove a navigation view
/navigation_views/:fragmentRemove a navigation view. Changes: New in Zulip 11.0 (feature level 390). - PATCHUpdate the navigation view
/navigation_views/:fragmentUpdate the details of an existing configured navigation view, such as its name or whether it's pinned. Changes: New in Zulip 11.0 (feature level 390).
reminders
- GETGet reminders
/remindersFetch all reminders for the current user. Reminders are messages the user has scheduled to be sent in the future to themself. Changes: New in Zulip 11.0… - POSTCreate a message reminder
/remindersSchedule a reminder to be sent to the current user at the specified time. The reminder will link the relevant message. Changes: New in Zulip 11.0 (feature… - DELETEDelete a reminder
/reminders/:reminder_idDelete, and therefore cancel sending, a previously scheduled reminder. Changes: New in Zulip 11.0 (feature level 399).
scheduled_messages
- GETGet scheduled messages
/scheduled_messagesFetch all scheduled messages for the current user. Scheduled messages are messages the user has scheduled to be sent in the future via the send later feature.… - POSTCreate a scheduled message
/scheduled_messagesCreate a new scheduled message. Changes: In Zulip 7.0 (feature level 184), moved support for editing a scheduled message to a separate API endpoint, which… - DELETEDelete a scheduled message
/scheduled_messages/:scheduled_message_idDelete, and therefore cancel sending, a previously scheduled message. Changes: New in Zulip 7.0 (feature level 173). - PATCHEdit a scheduled message
/scheduled_messages/:scheduled_message_idEdit an existing scheduled message. Changes: New in Zulip 7.0 (feature level 184).
mobile
- POSTSend a test notification to mobile device(s)
/mobile_push/test_notificationDeprecated. Trigger sending a test push notification to the user's selected mobile device or all of their mobile devices. Changes: Deprecated in Zulip 11.0… - POSTSend an E2EE test notification to mobile device(s)
/mobile_push/e2ee/test_notificationTrigger sending an end-to-end encrypted (E2EE) test push notification to the user's selected mobile device or all of their mobile devices. Changes: New in… - POSTRegister E2EE push device
/mobile_push/registerRegister a device to receive end-to-end encrypted mobile push notifications, or update such a registration. To perform an initial registration, clients must… - POSTRegister E2EE push device to bouncer
/remotes/push/e2ee/registerRegister a push device to bouncer to receive end-to-end encrypted mobile push notifications. Self-hosted servers use this endpoint to asynchronously register… - POSTRegister a logged-in device
/register_client_deviceLogged-in mobile devices use this endpoint as an initial step to register themselves, before registering for E2EE push notifications. This endpoint is… - POSTRemove a registered device
/remove_client_deviceMobile devices use this endpoint to remove their device record registered using POST /register_client_device when the user logs out. This endpoint is…
server_and_organizations
- POSTUpload custom emoji
/realm/emoji/:emoji_nameThis endpoint is used to upload a custom emoji for use in the user's organization. Access to this endpoint depends on the organization's configuration. - DELETEDeactivate custom emoji
/realm/emoji/:emoji_nameDeactivate a custom emoji from the user's organization. Users can only deactivate custom emoji that they added themselves except for organization… - GETGet all custom emoji
/realm/emojiGet all the custom emoji in the user's organization. - GETGet presence of all users
/realm/presenceGet the presence information of all the users in an organization. If the CAN_ACCESS_ALL_USERS_GROUP_LIMITS_PRESENCE server-level setting is set to true,… - GETGet allowed domains
/realm/domainsGet the set of allowed domains configured in the organization for user account email addresses. As each Zulip user account is associated with an email… - POSTAdd an allowed domain
/realm/domainsAdd a domain to the set of allowed domains configured in the organization for user account email addresses. Changes: Prior to Zulip 6.0 (feature level 143),… - DELETERemove an allowed domain
/realm/domains/:domainRemove the specified domain from the set of allowed domains configured in the organization for user account email addresses. Changes: Prior to Zulip 6.0… - PATCHUpdate an allowed domain
/realm/domains/:domainUpdate whether subdomains are allowed in user account email addresses for the specified domain. Changes: Prior to Zulip 6.0 (feature level 143), organization… - POSTDeactivate an organization
/realm/deactivateDeactivate an organization on the Zulip server. Deactivating an organization immediately logs out all of its users and prevents them from logging in again. A… - GETGet all custom profile fields
/realm/profile_fieldsGet all the custom profile fields configured for the user's organization. - POSTCreate a custom profile field
/realm/profile_fieldsCreate a custom profile field in the user's organization. - PATCHReorder custom profile fields
/realm/profile_fieldsReorder the custom profile fields in the user's organization. Custom profile fields are displayed in Zulip UI widgets in order; this endpoint allows… - DELETEDelete a custom profile field
/realm/profile_fields/:field_idDelete a custom profile field in the user's organization. This will also permanently delete any value configured for the custom profile field from every user… - PATCHUpdate a custom profile field
/realm/profile_fields/:field_idUpdate the configuration of a custom profile field in the user's organization. The type of a custom profile field cannot be changed. At most, 2 custom profile… - PATCHUpdate realm-level defaults of user settings
/realm/user_settings_defaultsChange the [default values of settings][new-user-defaults] for new users joining the organization. Essentially all personal preference settings are supported.… - GETGet linkifiers
/realm/linkifiersList all of an organization's configured linkifiers, regular expression patterns that are automatically linkified when they appear in messages and topics.… - PATCHReorder linkifiers
/realm/linkifiersChange the order that the regular expression patterns in the organization's linkifiers are matched in messages and topics. Useful when defining linkifiers… - POSTAdd a linkifier
/realm/filtersConfigure linkifiers, regular expression patterns that are automatically linkified when they appear in messages and topics. - DELETERemove a linkifier
/realm/filters/:filter_idRemove linkifiers, regular expression patterns that are automatically linkified when they appear in messages and topics. - PATCHUpdate a linkifier
/realm/filters/:filter_idUpdate a linkifier, regular expression patterns that are automatically linkified when they appear in messages and topics. Changes: New in Zulip 4.0 (feature… - POSTAdd a code playground
/realm/playgroundsConfigure code playgrounds for the organization. Changes: New in Zulip 4.0 (feature level 49). A parameter encoding bug was fixed in Zulip 4.0 (feature level… - DELETERemove a code playground
/realm/playgrounds/:playground_idRemove a code playground previously configured for an organization. Changes: New in Zulip 4.0 (feature level 49). - DELETEDelete a data export
/export/realm/:export_idDelete a completed public or standard [data export][export-data] of the organization. Data exports that happened on a previous server (i.e., an export with… - GETGet all data exports
/export/realmFetch all the public and standard [data exports][export-data] of the organization. Changes: Prior to Zulip 10.0 (feature level 304), only public data exports… - POSTCreate a data export
/export/realm!!! warn "" Note: If you're the administrator of a self-hosted installation, you may be looking for the documentation on [server data export and… - GETGet data export consent state
/export/realm/consentsFetches which users have consented for their private data to be exported by organization administrators. Changes: Changes in Zulip 12.0 (feature level 430).… - POSTTest welcome bot custom message
/realm/test_welcome_bot_custom_messageSends a test Welcome Bot custom message to the acting administrator. This allows administrators to preview how the custom welcome message will appear when… - GETGet server settings
/server_settingsFetch global settings for a Zulip server. Note: this endpoint does not require any authentication at all, and you can use it to check: If this is a Zulip…
invites
- GETGet all invitations
/invitesFetch all unexpired invitations (i.e. email invitations and reusable invitation links) that can be managed by the user. Note that administrators can manage… - POSTSend invitations
/invitesSend invitations to specified email addresses. Changes: In Zulip 6.0 (feature level 126), the invite_expires_in_days parameter was removed and replaced by… - POSTCreate a reusable invitation link
/invites/multiuseCreate a reusable invitation link which can be used to invite new users to the organization. Changes: In Zulip 8.0 (feature level 209), added support for… - DELETERevoke an email invitation
/invites/:invite_idRevoke an email invitation. A user can only revoke invitations that they can manage. - DELETERevoke a reusable invitation link
/invites/multiuse/:invite_idRevoke a reusable invitation link. A user can only revoke invitations that they can manage. Changes: Prior to Zulip 8.0 (feature level 209), only organization… - POSTResend an email invitation
/invites/:invite_id/resendResend an email invitation. A user can only resend invitations that they can manage.
webhooks
- POSTOutgoing webhooks
/zulip-outgoing-webhookOutgoing webhooks allow you to build or set up Zulip integrations which are notified when certain types of messages are sent in Zulip.
API details
- Base URL
https://{subdomain}.zulipchat.com/api/v1https://chat.zulip.org/api/v1http://localhost:9991/api/v1http://{subdomain}.testserver/json- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 167 operations on 120 pathsPOST 68GET 48DELETE 29PATCH 21PUT 1
9 marked deprecated - Main resources
- users 45channels 30server_and_organizations 28messages 20drafts 8invites 6mobile 6real_time_events 5authentication 4navigation_views 4
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0.0 - Links
- OpenAPI document · Support
- Listed from
- Zulip's published OpenAPI description (zulip/zulip) (Apache-2.0)
How to test the Zulip REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Zulip REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Fetch an API key (production)” (POST /fetch_api_key), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Zulip REST API?
Powerful open source group chat It is listed under Communication and has 167 endpoints.
Who publishes the Zulip REST API?
It is listed from Zulip's public API description (an OpenAPI document), not published by Zulip on Swastik Codes. Anyone who controls zulip.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Zulip REST API?
Its description lists 4 base URLs: https://{subdomain}.zulipchat.com/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Zulip REST API?
With HTTP Basic authentication (username and password).
How many endpoints does the Zulip REST API have?
167 operations on 120 paths (68 POST, 48 GET, 29 DELETE, 21 PATCH, 1 PUT). The largest groups are users, channels, server_and_organizations, messages.
Is forking the Zulip REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.