Skip to main content
| API documentation
Log in New organization

Zulip homepage

API documentation home

Integrations

  • Overview
  • Incoming webhook integrations
  • Hello world walkthrough
  • Non-webhook integrations

Interactive bots (beta)

  • Running bots
  • Deploying bots
  • Writing bots
  • Outgoing webhooks

REST API

  • Overview
  • Installation instructions
  • API keys
  • Configuring the Python bindings
  • HTTP headers
  • Error handling
  • Roles and permissions
  • Group-setting values
  • Message formatting
  • Client libraries
  • API changelog

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 a narrow
  • Get a message's edit history
  • Update personal message flags
  • Update personal message flags for narrow
  • Mark all messages as read
  • Mark messages in a channel as read
  • Mark messages in a topic as read
  • Get a message's read receipts
  • Get temporary URL for an uploaded file
  • Report a message

Scheduled messages

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

Message reminders

  • Create a message reminder
  • Get reminders
  • Delete a reminder

Drafts

  • Get drafts
  • Create drafts
  • Edit a draft
  • Delete a draft
  • Get all saved snippets
  • Create a saved snippet
  • Edit a saved snippet
  • Delete a saved snippet

Navigation views

  • Get all navigation views
  • Add a navigation view
  • Update the navigation view
  • Remove a navigation view

Channels

  • Get subscribed channels
  • Subscribe to a channel
  • Unsubscribe from a channel
  • Get subscription status
  • Get channel subscribers
  • Update subscription settings
  • Get all channels
  • Get a channel by ID
  • Get channel ID
  • Create a channel
  • Update a channel
  • Archive a channel
  • Get channel's email address
  • Get topics in a channel
  • Topic muting
  • Update personal preferences for a topic
  • Delete a topic
  • Add a default channel
  • Remove a default channel
  • Create a channel folder
  • Get channel folders
  • Reorder channel folders
  • Update a channel folder

Users

  • Get a user
  • Get a user by email
  • Get own user
  • Get users
  • Create a user
  • Update a user