The Armada REST API

The Armada REST API powers the Armada web app, so anything you can do in Armada, you can do with the 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 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 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
• Check thumbnail status
• 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
• Get a user's subscribed channels
• Update a subscription setting
• Bulk 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
• Update a user by email
• Deactivate a user
• Deactivate own user
• Reactivate a user
• Get a user's status
• Update your status
• Update user status
• Update your profile data
• Remove your profile data
• Upload your profile picture
• Delete your profile picture
• Set "typing" status
• Set "typing" status for message editing
• Get a user's presence
• Get presence of all users
• Update your presence
• Get attachments
• Delete an attachment
• Update settings
• Get user groups
• Create a user group
• Update a user group
• Deactivate a user group
• Update user group members
• Update subgroups of a user group
• Get user group membership status
• Get user group members
• Get subgroups of a user group
• Mute a user
• Unmute a user
• Get all alert words
• Add alert words
• Remove alert words
• Regenerate your API key
• Get a bot's API key
• Regenerate a bot's API key

Invitations

• Get all invitations
• Send invitations
• Create a reusable invitation link
• Resend an email invitation
• Revoke an email invitation
• Revoke a reusable invitation link

Server & organizations

• Get server settings
• Get linkifiers
• Add a linkifier
• Update a linkifier
• Remove a linkifier
• Reorder linkifiers
• Add a code playground
• Remove a code playground
• Get all custom emoji
• Upload custom emoji
• Deactivate custom emoji
• Get all custom profile fields
• Reorder custom profile fields
• Create a custom profile field
• Update realm-level defaults of user settings
• Get allowed domains
• Add an allowed domain
• Update an allowed domain
• Remove an allowed domain
• Get all data exports
• Create a data export
• Get data export consent state
• Test welcome bot custom message

Real-time events

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

Interactive bots

• Get a bot's stored data
• Update a bot's stored data
• Remove a bot's stored data

Armada plugins

• Get the organization's plugins
• Install a plugin
• Update a plugin
• Remove a plugin
• Undo a plugin's removal
• Retry a failed plugin
• Get a plugin's recent activity
• Get a plugin's tools
• Link a plugin to a channel or a topic
• Unlink a plugin
• Run a widget's action
• Push a plugin's widget
• Change your own view of a widget
• Go back to the team's view of a widget

Armada secrets

• Get the organization's secrets
• Add a secret
• Change a secret
• Remove a secret

Specialty endpoints

• Fetch an API key (production)
• Fetch an API key (development only)
• Fetch an API key (JWT)
• List users (development only)
• Register a logged-in device
• Remove a registered device
• Send an E2EE test notification to mobile device(s)
• Register E2EE push device
• Register E2EE push device to bouncer
• Mobile notifications
• Send a test notification to mobile device(s)
• Add an APNs device token
• Remove an APNs device token
• Add an FCM registration token
• Remove an FCM registration token
• Create BigBlueButton video call
• Create Constructor Groups video call
• Create Nextcloud Talk video call
• Create Webex video call
• Outgoing webhook payloads

Armada's server is a fork of Zulip, which is open source, so you can also consult the Zulip server source code as a workaround for how to do anything not documented here.