The Zulip REST API

The Zulip REST API powers the Zulip web and mobile apps, so anything you can do in Zulip, you can do with Zulip's REST API. To use this API:

• You'll need to get an API key. You will likely want to create a bot, unless you're using the API to interact with your own account (e.g. exporting your personal message history).
• Choose what language you'd like to use. You can download the Python or JavaScript bindings, projects in other languages, or just make HTTP requests with your favorite programming language.
• If you're making your own HTTP requests, you'll want to send the appropriate HTTP basic authentication headers.
• The Zulip API has a standard system for reporting errors.

Most other details are covered in the documentation for the individual endpoints:

Messages

• Send a message
• Upload a file
• Edit a message
• Delete a message
• Get messages
• Construct a narrow
• Add an emoji reaction
• Remove an emoji reaction
• Render a message
• Fetch a single message
• Check if messages match narrow
• Get a message's edit history
• Update personal message flags
• Update personal message flags for narrow
• Mark messages as read in bulk
• Get a message's read receipts

Scheduled messages

• Get scheduled messages
• Create a scheduled message
• Edit a scheduled message
• Delete a scheduled message

Drafts

• Get drafts
• Create drafts
• Edit a draft
• Delete a draft

Streams

• Get subscribed streams
• Subscribe to a stream
• Unsubscribe from a stream
• Get subscription status
• Get all subscribers
• Update subscription settings
• Get all streams
• Get a stream by ID
• Get stream ID
• Create a stream
• Update a stream
• Archive a stream
• Get topics in a stream
• Topic muting
• Update personal preferences for a topic
• Delete a topic
• Add a default stream
• Remove a default stream

Users

• Get all users
• Get own user
• Get a user
• Get a user by email
• Update a user
• Update your status
• Create a user
• Deactivate a user
• Reactivate a user
• Deactivate own user
• Set "typing" status
• Get user presence
• Get presence of all users
• Get attachments
• Delete an attachment
• Update settings
• Get user groups
• Create a user group
• Update a user group
• Delete a user group
• Update user group members
• Update user group subgroups
• Get user group membership status
• Get user group members
• Get subgroups of user group
• Mute a user
• Unmute a user
• Get all alert words
• Add alert words
• Remove alert words

Server & organizations

• Get server settings
• Get linkifiers
• Add a linkifier
• Update a linkifier
• Remove a linkifier
• Add a code playground
• Remove a code playground
• Get all custom emoji
• Upload custom emoji
• Get all custom profile fields
• Reorder custom profile fields
• Create a custom profile field
• Update realm-level defaults of user settings

Real-time events

• Real time events API
• Register an event queue
• Get events from an event queue
• Delete an event queue

Specialty endpoints

• Fetch an API key (production)
• Fetch an API key (development only)

Since Zulip is open source, you can also consult the Zulip server source code as a workaround for how to do anything not documented here.