API Reference

URLShort DescriptionReference
Authentication
/api/v1/loginLogin to the serverView
/api/v1/meThe current user detailsView
Channels
/api/v1/channels.closeUnsubscribe from a channelView
/api/v1/channels.countersGet channel countersView
/api/v1/channels.createCreate a new channelView
/api/v1/channels.deleteDelete a channelView
/api/v1/channels.filesList channel's filesView
/api/v1/channels.getAllUserMentionsByChannelList channel mentionsView
/api/v1/channels.historyRetrieves the messages for a channel.View
/api/v1/channels.infoGet a channel's informationView
/api/v1/channels.inviteInvite someone to a channelView
/api/v1/channels.kickKick someone from a channelView
/api/v1/channels.leaveLeave a channelView
/api/v1/channels.listRetrieves all of the channels from the server.View
/api/v1/channels.list.joinedGets only the channels the calling user has joinedView
/api/v1/channels.membersList channel's membersView
/api/v1/channels.messagesList channels messagesView
/api/v1/channels.openSubscribe to a channelView
/api/v1/channels.rolesList channel rolesView
Chat
/api/v1/chat.deleteDelete a chat messageView
/api/v1/chat.getDeletedMessagesRetrieve deleted messages since given dateView
/api/v1/chat.getMessageGet a chat messageView
/api/v1/chat.pinMessagePin a chat messageView
/api/v1/chat.reactSets/clears reaction to a messageView
/api/v1/chat.searchSearch chat messagesView
/api/v1/chat.sendMessageSend a chat messageView
/api/v1/chat.starMessageStar a chat messageView
/api/v1/chat.unPinMessageUnpin a chat messageView
/api/v1/chat.unStarMessageRemove a chat message starView
/api/v1/chat.updateUpdate a chat messageView
Slash Commands
/api/v1/commands.getGet specification of a slash commandView
/api/v1/commands.listList all available slash commandsView
/api/v1/commands.runExecute a slash command in the specified roomView
Direct Messages
/api/v1/dm.closeUnsubscribe from a channelView
/api/v1/dm.countersGet channel countersView
/api/v1/dm.createCreate a new channelView
/api/v1/dm.filesList channel's filesView
/api/v1/dm.historyRetrieves the messages for a channel.View
/api/v1/dm.listRetrieves all of the dm from the server.View
/api/v1/dm.membersList channel's membersView
/api/v1/dm.openSubscribe to a channelView
Private Groups
/api/v1/groups.closeUnsubscribe from a groupView
/api/v1/groups.countersGet group countersView
/api/v1/groups.createCreate a new groupView
/api/v1/groups.deleteDelete a groupView
/api/v1/groups.filesList group's filesView
/api/v1/groups.getAllUserMentionsByChannelList group mentionsView
/api/v1/groups.historyRetrieves the messages for a group.View
/api/v1/groups.inviteInvite someone to a groupView
/api/v1/groups.kickKick someone from a groupView
/api/v1/groups.leaveLeave a group.View
/api/v1/groups.listRetrieves all of the groups from the server.View
/api/v1/groups.list.joined GETGets only the groups the calling user has joinedView
/api/v1/groups.membersList group's membersView
/api/v1/groups.messagesList groups messagesView
/api/v1/groups.openSubscribe to a groupView
/api/v1/groups.rolesList group rolesView
Miscellaneous
/api/v1/_timesyncReturns the server's time (utc) in integer format.View
/api/v1/spotlightSearches for user or rooms that are visible to the userView
/api/v1/directorySearch by users or channelsView
/api/v1/push.tokenDeletes the push token for an authenticated user.View
Permissions
/api/v1/permissions.listGet all the permissions from the server.View
Rooms
/api/v1/rooms.upload/:ridPost a message with attached fileView
/api/v1/rooms.getGet all opened rooms of the current userView
/api/v1/rooms.saveNotificationSets the notifications settings for a specific channelView
Settings
/api/v1/settingsFetches all the settings for the serverView
/api/v1/settings.publicFetches the public settings for the serverView
/api/v1/settings/:idGet the setting for the provided setting nameView
Subscriptions
/api/v1/subscriptions.getGet all subscriptions for a userView
/api/v1/subscriptions.getOneGet the subscriptions for a given roomView
/api/v1/subscriptions.readMark a channel, group, or DM channel as readView
/api/v1/subscriptions.unreadMark a channel, group, or DM channel as unreadView
Users
/api/v1/users.getAvatarGet the URL of the user's avatarView
/api/v1/users.getPresenceGet the online presence of a userView
/api/v1/users.infoGet a user's informationView
/api/v1/users.resetAvatarReset a User's avatar to its initial stateView
/api/v1/users.setAvatarSet a User's avatarView
/api/v1/users.updateUpdate a user's dataView
/api/v1/users.updateOwnBasicInfoUpdate the user's basic informationView
WebRTC
/api/v1/webrtc.getIceServersGet the list of ICE ServersView
Video Conference
/api/v1/video-conference/jitsi.update-timeoutHandle video conference participant heartbeatsView
/api/v1/video-conference/jitsi.user-joinedAdd a user to a video conferenceView
/api/v1/video-conference/jitsi.user-leftRemove a user from a video conferenceView