Fuselage

Team Collaboration Endpoints

Assets Endpoints

URL

Short Description

Details Page

/api/v1/assets.setAsset

Set an asset image by name.

Link

/api/v1/assets.unsetAsset

Unset an asset by name.

Link

Auto Translate Endpoints

URL

Short Description

Details Page

/api/v1/autotranslate.getSupportedLanguages

Get the supported languages by auto-translate.

Link

/api/v1/autotranslate.saveSettings

Save some settings about auto-translate.

Link

/api/v1/autotranslate.translateMessage

Translate the message.

Link

Banners Endpoints

URL

Short Description

Details Page

/api/v1/banners.getNew

Get

Document Under Development

/api/v1/banners.dismiss

Post

Document Under Development

Channels Endpoints

These methods apply to public channels only. Use groups.* methods for private channels.

URL

Short Description

Details Page

/api/v1/channels.addAll

Adds all of the users on the server to a channel.

Link

/api/v1/channels.addLeader

Gives the role of Leader for a user in the current channel.

Link

/api/v1/channels.addModerator

Gives the role of moderator to a user in a channel.

Link

/api/v1/channels.addOwner

Gives the role of owner to a user in a channel.

Link

/api/v1/channels.anonymousread

Gets the messages in public channels to an anonymous user

Link

/api/v1/channels.archive

Archives a channel.

Link

/api/v1/channels.close

Removes a channel from a user's list of channels.

Link

/api/v1/channels.counters

Gets channel counters.

Link

/api/v1/channels.create

Creates a new channel.

Link

/api/v1/channels.delete

Removes a channel.

Link

/api/v1/channels.getAllUserMentionsByChannel

Gets all the mentions of a channel.

Link

/api/v1/channels.files

Gets a list of files from a channel.

Link

/api/v1/channels.getIntegrations

Gets the channel's integration.

Link

/api/v1/channels.history

Retrieves the messages from a channel.

Link

/api/v1/channels.info

Gets a channel's information.

Link

/api/v1/channels.invite

Adds a user to a channel.

Link

/api/v1/channels.join

Joins yourself to a channel.

Link

/api/v1/channels.kick

Removes a user from a channel.

Link

/api/v1/channels.leave

Removes the calling user from a channel.

Link

/api/v1/channels.list

Retrieves all of the channels from the server.

Link

/api/v1/channels.list.joined

Gets only the channels the calling user has joined.

Link

/api/v1/channels.members

Retrieves all channel users.

Link

/api/v1/channels.messages

Retrieves all channel messages.

Link

/api/v1/channels.moderators

List all moderators of a channel.

Link

/api/v1/channels.online

List all online users of a channel.

Link

/api/v1/channels.open

Adds the channel back to the user's list of channels.

Link

/api/v1/channels.removeleader

Removes the role of Leader for a user in the current channel.

Link

/api/v1/channels.removeModerator

Removes the role of moderator from a user in a channel.

Link

/api/v1/channels.removeOwner

Removes the role of owner from a user in a channel.

Link

/api/v1/channels.rename

Changes a channel's name.

Link

/api/v1/channels.roles

Gets the user's roles in the channel.

Link

/api/v1/channels.setAnnouncement

Sets a channel's announcement.

Link

/api/v1/channels.setCustomFields

Sets a channel's custom fields.

Link

/api/v1/channels.setDefault

Sets a channel's default status.

Link

/api/v1/channels.setDescription

Sets a channel's description.

Link

/api/v1/channels.setJoinCode

Sets the channel's code required to join it.

Link

/api/v1/channels.setPurpose

Sets a channel's description.

Link

/api/v1/channels.setReadOnly

Sets whether a channel is read-only or not.

Link

/api/v1/channels.setTopic

Sets a channel's topic.

Link

/api/v1/channels.setType

Sets the type of room the channel should be.

Link

/api/v1/channels.unarchive

Unarchives a channel.

Link

/api/v1/channels.convertToTeam

Convert channel to team

Link

Chat Endpoints

URL

Short Description

Details Page

/api/v1/chat.delete

Deletes an existing chat message.

Link

/api/v1/chat.followMessage

Follows an existing chat message.

Link

/api/v1/chat.getDeletedMessages

Retrieves the deleted messages from a specific date.

Link

/api/v1/chat.getDiscussions

Retrieves the discussions of a room.

Link

/api/v1/chat.getMentionedMessages

Retrieves the mentioned messages.

Link

/api/v1/chat.getMessage

Retrieves a single chat message.

Link

/api/v1/chat.getMessageReadReceipts

Retrieves message read receipts.

Link

/api/v1/chat.getPinnedMessages

Retrieve pinned messages from a room.

Link

/api/v1/chat.getSnippetedMessages

Retrieves snippeted messages.

Link

/api/v1/chat.getSnippetedMessageById

Retrieves snippeted message by id.

Link

/api/v1/chat.getStarredMessages

Retrieves the starred messages.

Link

/api/v1/chat.getThreadMessages

Retrieves thread's messages.

Link

/api/v1/chat.getThreadsList

Retrieves channel's threads.

Link

/api/v1/chat.ignoreUser

Ignores abuser from a chat.

Link

/api/v1/chat.pinMessage

Pins a chat message to the message's channel.

Link

/api/v1/chat.postMessage

Posts a new chat message.

Link

/api/v1/chat.react

Sets/unsets the user's reaction to an existing chat message.

Link

/api/v1/chat.reportMessage

Reports a message.

Link

/api/v1/chat.search

Search for messages in a channel.

Link

/api/v1/chat.starMessage

Stars a chat message for the authenticated user.

Link

/api/v1/chat.sendMessage

Send a new chat message.

Link

/api/v1/chat.syncThreadMessages

Retrieves synced thread's messages.

Link

/api/v1/chat.syncThreadsList

Retrieves thread's synced channel threads.

Link

/api/v1/chat.unfollowMessage

Unfollows an existing chat message.

Link

/api/v1/chat.unPinMessage

Removes the pinned status of the provided chat message.

Link

/api/v1/chat.unStarMessage

Removes the star on the chat message for the authenticated user.

Link

/api/v1/chat.update

Updates the text of the chat message.

Link

/api/v1/chat.syncMessages

get

Document Under Development

Cloud Endpoints

URL

Short Description

Details Page

/api/v1/cloud.manualRegister

Post

Document Under Development

Commands Endpoints

URL

Short Description

Details Page

/api/v1/commands.get

Get the specification of the slash command.

Link

/api/v1/commands.list

Lists all available slash commands.

Link

/api/v1/commands.run

Execute a slash command in the specified room.

Link

/api/v1/commands.preview

Gets the preview data for the command and executes the preview item.

Link

/api/v1/commands.preview

Execute command's preview item

Link

Custom Sounds Endpoints

URL

Short Description

Details Page

/api/v1/custom-sounds.list

Retrieves a list of custom sounds.

Link

Custom User Status Endpoints

URL

Short Description

Details Page

/api/v1/custom-user-status.list

Lists all available custom user's status.

Link

/api/v1/custom-user-status.create

post

Document Under Development

/api/v1/custom-user-status.delete

post

Document Under Development

/api/v1/custom-user-status.update

post

Document Under Development

DNS Endpoints

URL

Short Description

Details Page

/api/v1/dns.resolve.srv

get

Document Under Development

/api/v1/dns.resolve.txt

post

Document Under Development

E2E Endpoints

URL

Short Description

Details Page

/api/v1/e2e.fetchMyKeys

get

Document Under Development

/api/v1/e2e.getUsersOfRoomWithoutKey

post

Document Under Development

/api/v1/e2e.setRoomKeyID

post

Document Under Development

/api/v1/e2e.setUserPublicAndPrivateKeys

post

Document Under Development

/api/v1/e2e.updateGroupKey

post

Document Under Development

Email Inbox Endpoints

URL

Short Description

Details Page

/api/v1/email-inbox.list

get

Document Under Development

/api/v1/email-inbox

post

Document Under Development

/api/v1/email-inbox/:_id

get

Document Under Development

/api/v1/email-inbox/:_id

delete

Document Under Development

/api/v1/email-inbox.search

get

Document Under Development

/api/v1/email-inbox.send-test/:_id

post

Document Under Development

Custom Emojis Endpoints

Url

Short Description

Details Page

/api/v1/emoji-custom.all

Retrieves all custom emojis

Link

/api/v1/emoji-custom.list

Get an updated list of custom emojis

Link

/api/v1/emoji-custom.create

Create new custom emoji.

Link

/api/v1/emoji-custom.delete

Delete an existent custom emoji.

Link

/api/v1/emoji-custom.update

Update an existent custom emoji.

Link

Groups Endpoints

Url

Short Description

Details Page

/api/v1/groups.addAll

Adds all of the users on the server to a private group.

Link

/api/v1/groups.addLeader

Gives the role of Leader for a user in the current group.

Link

/api/v1/groups.addModerator

Gives the role of moderator to a user in a group.

Link

/api/v1/groups.addOwner

Gives the role of owner to a user in a group.

Link

/api/v1/groups.archive

Archives a private group.

Link

/api/v1/groups.close

Removes a private group from the list of groups.

Link

/api/v1/groups.counters

Gets group counters.

Link

/api/v1/groups.create

Creates a new private group.

Link

/api/v1/groups.delete

Removes a private group.

Link

/api/v1/groups.files

Gets a list of files from a private group.

Link

/api/v1/groups.getIntegrations

Gets the integrations assigned to the group.

Link

/api/v1/groups.history

Retrieves the messages from a private group.

Link

/api/v1/groups.info

Gets the information about a private group.

Link

/api/v1/groups.invite

Adds a user to the private group.

Link

/api/v1/groups.kick

Removes a user from a private group.

Link

/api/v1/groups.leave

Removes the calling user from the private group.

Link

/api/v1/groups.list

List the private groups the caller is part of.

Link

/api/v1/groups.listAll

List all the private groups.

Link

/api/v1/groups.moderators

List all moderators of a group.

Link

/api/v1/groups.members

Gets the users of participants of a private group.

Link

/api/v1/groups.messages

Retrieves all group messages.

Link

/api/v1/groups.online

List all online users of a group.

Link

/api/v1/groups.open

Adds the private group back to the list of groups.

Link

/api/v1/groups.removeLeader

Removes the role of Leader for a user in the current group.

Link

/api/v1/groups.removeModerator

Removes the role of moderator from a user in a group.

Link

/api/v1/groups.removeOwner

Removes the role of owner from a user in a group.

Link

/api/v1/groups.rename

Changes the name of the private group.

Link

/api/v1/groups.roles

Gets the user's roles in the private group.

Link

/api/v1/groups.setAnnouncement

Sets a group's announcement.

Link

/api/v1/groups.setCustomFields

Sets private group's custom fields.

Link

/api/v1/groups.setDescription

Sets a private group's description.

Link

/api/v1/groups.setPurpose

Sets a private group's description.

Link

/api/v1/groups.setReadOnly

Sets whether the room is read-only or not.

Link

/api/v1/groups.setTopic

Sets a private group's topic.

Link

/api/v1/groups.setType

Sets the type of room this group will be.

Link

/api/v1/groups.unarchive

Unarchives a private group.

Link

/api/v1/groups.setEncrypted

``

Document Under Development

/api/v1/groups.convertToTeam

Document Under Development

IM Endpoints

Url

Short Description

Details Page

/api/v1/im.delete

post

Document Under Development

/api/v1/im.close

Removes a direct message from the list of direct messages.

Link

/api/v1/im.counters

Gets counters of direct messages.

Link

/api/v1/im.create

Create a direct message session with another user.

Link

/api/v1/im.history

Retrieves the messages from a direct message.

Link

/api/v1/im.files

Retrieves a list of files from a direct message.

Link

/api/v1/im.members

Retrieves the users of participants of a direct message.

Link

/api/v1/im.messages

Retrieves the messages from the specific direct messages.

Link

/api/v1/im.messages.others

Retrieves the messages from any direct message in the server.

Link

/api/v1/im.list

List the direct messages the caller is part of.

Link

/api/v1/im.list.everyone

List all direct messages to the caller in the server.

Link

/api/v1/im.open

Adds the direct message back to the list of direct messages.

Link

/api/v1/im.setTopic

Sets a direct message topic.

Link

Url

Short Description

Details Page

/api/v1/im.delete

post

Document Under Development

/api/v1/im.close

Removes a direct message from the list of direct messages.

Link

/api/v1/im.counters

Gets counters of direct messages.

Link

/api/v1/im.create

Create a direct message session with another user.

Link

/api/v1/im.history

Retrieves the messages from a direct message.

Link

/api/v1/im.files

Retrieves a list of files from a direct message.

Link

/api/v1/im.members

Retrieves the users of participants of a direct message.

Link

/api/v1/im.messages

Retrieves the messages from the specific direct messages.

Link

/api/v1/im.messages.others

Retrieves the messages from any direct message in the server.

Link

/api/v1/im.list

List the direct messages the caller is part of.

Link

/api/v1/im.list.everyone

List all direct messages the caller in the server.

Link

/api/v1/im.open

Adds the direct message back to the list of direct messages.

Link

/api/v1/im.setTopic

Sets a direct message topic.

Link

Url

Short Description

Details Page

/api/v1/im.delete

post

Document Under Development

/api/v1/im.close

Removes a direct message from the list of direct messages.

Link

/api/v1/im.counters

Gets counters of direct messages.

Link

/api/v1/im.create

Create a direct message session with another user.

Link

/api/v1/im.delete

Remove a direct message session.

Link

/api/v1/im.history

Retrieves the messages from a direct message.

Link

/api/v1/im.files

Retrieves a list of files from a direct message.

Link

/api/v1/im.members

Retrieves the users of participants of a direct message.

Link

/api/v1/im.messages

Retrieves the messages from the specific direct messages.

Link

/api/v1/im.messages.others

Retrieves the messages from any direct message in the server.

Link

/api/v1/im.list

List the direct messages the caller is part of.

Link

/api/v1/im.list.everyone

List all direct messages the caller in the server.

Link

/api/v1/im.open

Adds the direct message back to the list of direct messages.

Link

/api/v1/im.setTopic

Sets a direct message topic.

Link

Notes

From version 0.50.0 and on you can call the methods using dm instead of im.

Imports Endpoints

URL

Short Description

Details Page

/api/v1/uploadImportFile

Content

Document Under Development

/api/v1/downloadPublicImportFile

Content

Document Under Development

/api/v1/startImport

Content

Document Under Development

/api/v1/getImportFileData

Content

Document Under Development

/api/v1/getImportProgress

Content

Document Under Development

/api/v1/getLatestImportOperations

Content

Document Under Development

/api/v1/downloadPendingFiles

Content

Document Under Development

/api/v1/downloadPendingAvatars

Content

Document Under Development

/api/v1/getCurrentImportOperation

Content

Document Under Development

Instances Endpoints

URL

Short Description

Details Page

/api/v1/instances.get

get

Document Under Development

Integrations Endpoints

Url

Short Description

Details Page

/api/v1/integrations.create

Creates an integration.

Link

/api/v1/integrations.get

Gets an integration.

Link

/api/v1/integrations.history

Lists all history of the specified integration.

Link

/api/v1/integrations.list

Lists all of the integrations.

Link

/api/v1/integrations.remove

Removes an integration.

Link

/api/v1/integrations.update

put

Document Under Development

Invites Endpoints

Url

Short Description

Details Page

/api/v1/findOrCreateInvite

Created a new Invite or returns an existing one with the same parameters.

Link

/api/v1/listInvites

Lists all of the invite tokens.

Link

/api/v1/removeInvite/:_id

delete

Document Under Development

/api/v1/useInviteToken

Report to the server that an invite token was used.

Link

/api/v1/validateInviteToken

Checks if an invite token is valid.

Link

Misc Endpoints

Just some generic information, such as information about the server and authenticated user.

Url

Short Description

Details Page

/api/v1/directory

Search by all users and channels available on server.

Link

/api/v1/shield.svg

Gets the shield SVG (badge) to add in your website.

Link

/api/v1/spotlight

Searches for users or rooms that are visible to the user.

Link

/api/v1/me

get

Document Under Development

/api/v1/stdout.queue

get

Document Under Development

/api/v1/stdout.queue

post

Document Under Development

Oauth apps Endpoints

Url

Short Description

Details Page

/api/v1/oauth-apps.get

Retrieves an OAuth App by id or client id.

Link

/api/v1/oauth-apps.list

Retrieves a list of OAuth Apps.

Link

Permissions Endpoints

Url

Short Description

Details Page

/api/v1/permissions.listAll

Lists permissions on the server.

Link

/api/v1/permissions.update

Edits permissions on the server.

Link

Push Endpoints

Url

Method

Short Description

Details Page

/api/v1/push.token

POST

Saves push token.

Link

/api/v1/push.token

DELETE

Removes push token.

Link

/api/v1/push.get

get

Document Under Development

Roles Endpoints

Url

Short Description

Details Page

/api/v1/roles.list

List all roles on the server.

Link

/api/v1/roles.sync

List all roles on the server which are updated after a given date.

Link

/api/v1/roles.create

Create a new role.

Link

/api/v1/roles.addUserToRole

Edits permissions on the server.

Link

/api/v1/roles.getUsersInRole

Gets the users that belong to a role.

Link

/api/v1/roles.update

Update an existing role in the system.

Link

/api/v1/roles.delete

Delete a role.

Link

/api/v1/roles.removeUserFromRole

Unassign a role from a user.

Link

Rooms Endpoints

Url

Method

Short Description

Details Page

/api/v1/rooms.adminRooms

GET

Retrieve all rooms (requires special permission).

Link

/api/v1/rooms.cleanHistory

POST

Cleans up a room's history, requires special permission.

Link

/api/v1/rooms.createDiscussion

POST

Creates a new discussion.

Link

/api/v1/rooms.favorite

POST

Favorite/Unfavorite room.

Link

/api/v1/rooms.get

GET

Gets rooms.

Link

/api/v1/rooms.getDiscussions

GET

Gets room's discussions.

Link

/api/v1/rooms.info

GET

Gets info from a room.

Link

/api/v1/rooms.leave

POST

Leaves a room.

Link

/api/v1/rooms.saveNotification

POST

Sets the notification settings of specific channel.

Link

/api/v1/rooms.upload/:rid

POST

Upload a message with attached file.

Link

/api/v1/rooms.adminRooms.getRoom

GET

``

Document Under Development

/api/v1/rooms.autocomplete.channelAndPrivate

GET

``

Document Under Development

/api/v1/rooms.autocomplete.availableForTeams

GET

``

Document Under Development

/api/v1/rooms.saveRoomSettings

POST

``

Document Under Development

/api/v1/rooms.changeArchivationState

POST

``

Document Under Development

/api/v1/rooms.export

POST

Document Under Development

Settings Endpoints

You can get and update the settings via the REST API, only if you have permission to.

Url

Method

Short Description

Details Page

/api/v1/settings

GET

Lists all private settings.

Link

/api/v1/settings.public

GET

Lists all public settings.

Link

/api/v1/settings.oauth

GET

Return list of all available oauth services.

Link

/api/v1/service.configurations

GET

Lists all service configurations.

Link

/api/v1/settings/:_id

GET

Gets a setting.

Link

/api/v1/settings/:_id

POST

Updates a setting.

Link

Stats Endpoints

URL

Short Description

Details Page

/api/v1/statistics

get

Document Under Development

/api/v1/statistics.list

get

Document Under Development

Subscriptions Endpoints

Url

Short Description

Details Page

/api/v1/subscriptions.get

Get all subscriptions.

Link

/api/v1/subscriptions.getOne

Get the subscription by room Id.

Link

/api/v1/subscriptions.read

Mark a room as read.

Link

/api/v1/subscriptions.unread

Mark messages as unread.

Link

Teams Endpoints

Url

Short Description

Details Page

/api/v1/teams.list

Lists the public and private teams the caller is part of.

Link

/api/v1/teams.listAll

Lists all of the teams and their information.

Link

/api/v1/teams.create

Creates a new team.

Link

/api/v1/teams.convertToChannel

post

Document Under Development

/api/v1/teams.addRooms

Adds rooms to the team.

Link

/api/v1/teams.removeRoom

Removes a room from a team.

Link

/api/v1/teams.updateRoom

Updates a room from a team, limited to permissions.

Link

/api/v1/teams.listRooms

Lists all rooms of the team.

Link

/api/v1/teams.listRoomsOfUser

Lists only the team's rooms the user has joined.

Link

/api/v1/teams.members

Retrieves all team members.

Link

/api/v1/teams.addMembers

Adds members to the team.

Link

/api/v1/teams.updateMember

Updates a team member's roles, limited to permissions.

Link

/api/v1/teams.removeMember

Removes a member from a team.

Link

/api/v1/teams.leave

Leaves a team.

Link

/api/v1/teams.info

Gets a team's information.

Link

/api/v1/teams.delete

Removes a team.

Link

/api/v1/teams.autocomplete

Lists the teams whose names match a given pattern.

Link

/api/v1/teams.update

Updates an existing team (name and type).

Link

Users Endpoints

URL

Method

Short Description

Details Page

/api/v1/users.create

Post

Create a new user

Link

/api/v1/users.delete

Post

Deletes an existing user

Link

/api/v1/users.deleteOwnAccount

Post

Deletes your own user

Link

/api/v1/users.getAvatar

Get

Gets the URL for a user’s avatar.

Link

/api/v1/users.setActiveStatus

Post

Set user's active status

Link

/api/v1/users.deactivateIdle

Post

Deactivate Idle users

Link

/api/v1/users.getPresence

Get

Gets a user's presence

Link

/api/v1/users.info

Get

Retrieves information about a user

Link

/api/v1/users.list

Get

Get all of the users in the system and their information

Link

/api/v1/users.register

Post

Register users

Link

/api/v1/users.resetAvatar

Post

Reset avatar

Link

/api/v1/users.setAvatar

Post

Set avatar

Link

/api/v1/users.getStatus

Get

Gets a user's status

Link

/api/v1/users.setStatus

Post

Sets a user status

Link

/api/v1/users.update

Post

Update user

Link

/api/v1/users.updateOwnBasicInfo

Post

Update own basic information

Link

/api/v1/users.createToken

Post

Create a user authentication token

Link

/api/v1/users.getPreferences

Get

Gets all preferences of the user.

Link

/api/v1/users.setPreferences

Post

Sets preferences of the user.

Link

/api/v1/users.forgotPassword

Post

Send an email to reset your password.

Link

/api/v1/users.getUsernameSuggestion

Get

Suggestion of new username to user.

Link

/api/v1/users.generatePersonalAccessToken

Post

Generate Personal Access Token

Link

/api/v1/users.regeneratePersonalAccessToken

Post

Regenerate a user's personal access token

Link

/api/v1/users.getPersonalAccessTokens

Get

Gets the user’s personal access tokens

Link

/api/v1/users.removePersonalAccessToken

Post

Remove a personal access token

Link

/api/v1/users.2fa.enableEmail

Post

Document Under Development

/api/v1/users.2fa.disableEmail

Post

Document Under Development

/api/v1/users.2fa.sendEmailCode

post

Document Under Development

/api/v1/users.presence

Get

Gets all connected users presence.

Link

/api/v1/users.requestDataDownload

Get

Request the user's data for download.

Link

/api/v1/users.logoutOtherClients

Post

Document Under Development

/api/v1/users.autocomplete

Get

Document Under Development

/api/v1/users.removeOtherTokens

Post

Remove other tokens

Link

/api/v1/users.resetE2EKey

post

Document Under Development

/api/v1/users.resetTOTP

post

Document Under Development

/api/v1/users.listTeams

get

Document Under Development

/api/v1/users.logout

post

Document Under Development

Video Conference Endpoints

URL

Short Description

Details Page

/api/v1/video-conference/jitsi.update-timeout

Updates the timeout of Jitsi video conference in a channel.

Link

Webdav Endpoints

URL

Short Description

Details Page

/api/v1/webdav.getMyAccounts

Retrieves the user's webdav accounts

Link