Core 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. | |
/api/v1/channels.addLeader | Gives the role of Leader for a user in the current channel. | |
/api/v1/channels.addModerator | Gives the role of moderator to a user in a channel. | |
/api/v1/channels.addOwner | Gives the role of owner to a user in a channel. | |
/api/v1/channels.anonymousread | Gets the messages in public channels to an anonymous user | |
/api/v1/channels.archive | Archives a channel. | |
/api/v1/channels.close | Removes a channel from a user's list of channels. | |
/api/v1/channels.counters | Retrieves channel counters. | |
/api/v1/channels.create | Creates a new channel. | |
/api/v1/channels.delete | Removes a channel. | |
/api/v1/channels.getAllUserMentionsByChannel | Retrieves all the mentions of a channel. | |
/api/v1/channels.files | Retrieves a list of files from a channel. | |
/api/v1/channels.getIntegrations | Retrieves the channel's integration. | |
/api/v1/channels.history | Retrieves the messages from a channel. | |
/api/v1/channels.info | Gets a channel's information. | |
/api/v1/channels.invite | Adds a user to a channel. | |
/api/v1/channels.join | Joins yourself to a channel. | |
/api/v1/channels.kick | Removes a user from a channel. | |
/api/v1/channels.leave | Removes the calling user from a channel. | |
/api/v1/channels.list | Retrieves all of the channels from the server. | |
/api/v1/channels.list.joined | Retrieves only the channels the calling user has joined. | |
/api/v1/channels.members | Retrieves all channel users. | |
/api/v1/channels.messages | Retrieves all channel messages. | |
/api/v1/channels.moderators | Lists all moderators of a channel. | |
/api/v1/channels.online | Lists all online users of a channel. | |
/api/v1/channels.open | Adds the channel back to the user's list of channels. | |
/api/v1/channels.removeleader | Removes the role of Leader for a user in the current channel. | |
/api/v1/channels.removeModerator | Removes the role of moderator from a user in a channel. | |
/api/v1/channels.removeOwner | Removes the role of the owner from a user in a channel. | |
/api/v1/channels.rename | Changes a channel's name. | |
/api/v1/channels.roles | Gets the user's roles in the channel. | |
/api/v1/channels.setAnnouncement | Sets a channel's announcement. | |
/api/v1/channels.setCustomFields | Sets a channel's custom fields. | |
/api/v1/channels.setDefault | Sets a channel's default status. | |
/api/v1/channels.setDescription | Sets a channel's description. | |
/api/v1/channels.setJoinCode | Sets the channel's code required to join it. | |
/api/v1/channels.setPurpose | Sets a channel's description. | |
/api/v1/channels.setReadOnly | Sets whether a channel is read-only or not. | |
/api/v1/channels.setTopic | Sets a channel's topic. | |
/api/v1/channels.setType | Sets the type of room the channel should be. | |
/api/v1/channels.unarchive | Unarchives a channel. | |
/api/v1/channels.convertToTeam | Converts channel to team |
URL | Short Description | Details Page |
---|---|---|
/api/v1/chat.delete | Deletes an existing chat message. | |
/api/v1/chat.followMessage | Follows an existing chat message. | |
/api/v1/chat.getDeletedMessages | Retrieves the deleted messages from a specific date. | |
/api/v1/chat.getDiscussions | Retrieves the discussions of a room. | |
/api/v1/chat.getMentionedMessages | Retrieves the mentioned messages. | |
/api/v1/chat.getMessage | Retrieves a single chat message. | |
/api/v1/chat.getMessageReadReceipts | Retrieves message read receipts. | |
/api/v1/chat.getPinnedMessages | Retrieves pinned messages from a room. | |
/api/v1/chat.getSnippetedMessages | Retrieves snippet messages. | |
/api/v1/chat.getSnippetedMessageById | Retrieves snippet message by id. | |
/api/v1/chat.getStarredMessages | Retrieves the starred messages. | |
/api/v1/chat.getThreadMessages | Retrieves thread's messages. | |
/api/v1/chat.getThreadsList | Retrieves channel's threads. | |
/api/v1/chat.ignoreUser | Ignores abuser from a chat. | |
/api/v1/chat.pinMessage | Pins a chat message to the message's channel. | |
/api/v1/chat.postMessage | Posts a new chat message. | |
/api/v1/chat.react | Sets/unsets the user's reaction to an existing chat message. | |
/api/v1/chat.reportMessage | Reports a message. | |
/api/v1/chat.search | Searches for messages in a channel. | |
/api/v1/chat.starMessage | Stars a chat message for the authenticated user. | |
/api/v1/chat.sendMessage | Sends a new chat message. | |
/api/v1/chat.syncThreadMessages | Retrieves synced thread's messages. | |
/api/v1/chat.syncThreadsList | Retrieves thread's synced channel threads. | |
/api/v1/chat.unfollowMessage | Unfollows an existing chat message. | |
/api/v1/chat.unPinMessage | Removes the pinned status of the provided chat message. | |
/api/v1/chat.unStarMessage | Removes the star on the chat message for the authenticated user. | |
/api/v1/chat.update | Updates the text of the chat message. | |
/api/v1/chat.syncMessages | Syncs messages |
URL | Short Description | Details Page |
---|---|---|
/api/v1/cloud.manualRegister | Manually registers a workspace |
URL | Short Description | Details Page |
---|---|---|
/api/v1/commands.get | Retrieves the specification of the slash command. | |
/api/v1/commands.list | Lists all available slash commands. | |
/api/v1/commands.run | Executes a slash command in the specified room. | |
/api/v1/commands.preview | Retrieves the preview data for the command and executes the preview item. | |
/api/v1/commands.preview | Executes command's preview item |
URL | Short Description | Details Page |
---|---|---|
/api/v1/custom-sounds.list | Retrieves a list of custom sounds. |
URL | Short Description | Details Page |
---|---|---|
/api/v1/custom-user-status.list | Lists all available custom user's status. | |
/api/v1/custom-user-status.create | Creates custom user status | |
/api/v1/custom-user-status.delete | Deletes a custom user status | |
/api/v1/custom-user-status.update | Updates a custom user status |
URL | Short Description | Details Page |
---|---|---|
/api/v1/dns.resolve.srv | get | Document Under Development |
/api/v1/dns.resolve.txt | Resolves DNS text records (TXT records) for a hostname |
URL | Short Description | Details Page |
---|---|---|
/api/v1/e2e.fetchMyKeys | Retrieves E2E keys of logged in user | |
/api/v1/e2e.getUsersOfRoomWithoutKey | Retrieves Users Of Room Without E2E Key | |
/api/v1/e2e.setRoomKeyID | Sets the end-to-end encryption key ID for a room | |
/api/v1/e2e.setUserPublicAndPrivateKeys | Sets the end-to-end encryption keys for the authenticated user. | |
/api/v1/e2e.updateGroupKey | Updates the end-to-end encryption key for a user in a room. |
URL | Short Description | Details Page |
---|---|---|
/api/v1/email-inbox.list | Retrieves mail Inbox list | |
/api/v1/email-inbox | Sets the email inbox for your server | |
/api/v1/email-inbox/:_id | Retrieves email Inbox by id | |
/api/v1/email-inbox/:_id | Delete email inbox using id | |
/api/v1/email-inbox.search | Searches email inbox by address | |
/api/v1/email-inbox.send-test/:_id | Sends test email to email inbox |
Url | Short Description | Details Page |
---|---|---|
/api/v1/emoji-custom.all | Retrieves all custom emojis | |
/api/v1/emoji-custom.list | Retrieves an updated list of custom emojis | |
/api/v1/emoji-custom.create | Creates new custom emoji. | |
/api/v1/emoji-custom.delete | Delete an existent custom emoji. | |
/api/v1/emoji-custom.update | Updates an existent custom emoji. |
Url | Short Description | Details Page |
---|---|---|
/api/v1/groups.addAll | Adds all of the users on the server to a private group. | |
/api/v1/groups.addLeader | Gives the role of Leader for a user in the current group. | |
/api/v1/groups.addModerator | Gives the role of moderator to a user in a group. | |
/api/v1/groups.addOwner | Gives the role of owner to a user in a group. | |
/api/v1/groups.archive | Archives a private group. | |
/api/v1/groups.close | Removes a private group from the list of groups. | |
/api/v1/groups.counters | Retrieves group counters. | |
/api/v1/groups.create | Creates a new private group. | |
/api/v1/groups.delete | Removes a private group. | |
/api/v1/groups.files | Retrieves a list of files from a private group. | |
/api/v1/groups.getIntegrations | Retrieves the integrations assigned to the group. | |
/api/v1/groups.history | Retrieves the messages from a private group. | |
/api/v1/groups.info | Retrieves the information about a private group. | |
/api/v1/groups.invite | Adds a user to the private group. | |
/api/v1/groups.kick | Removes a user from a private group. | |
/api/v1/groups.leave | Removes the calling user from the private group. | |
/api/v1/groups.list | Lists the private groups the caller is part of. | |
/api/v1/groups.listAll | Lists all the private groups. | |
/api/v1/groups.moderators | Lists all moderators of a group. | |
/api/v1/groups.members | Retrieves the users of participants of a private group. | |
/api/v1/groups.messages | Retrieves all group messages. | |
/api/v1/groups.online | Lists all online users of a group. | |
/api/v1/groups.open | Adds the private group back to the list of groups. | |
/api/v1/groups.removeLeader | Removes the role of Leader for a user in the current group. | |
/api/v1/groups.removeModerator | Removes the role of moderator from a user in a group. | |
/api/v1/groups.removeOwner | Removes the role of owner from a user in a group. | |
/api/v1/groups.rename | Changes the name of the private group. | |
/api/v1/groups.roles | Retrieves the user's roles in the private group. | |
/api/v1/groups.setAnnouncement | Sets a group's announcement. | |
/api/v1/groups.setCustomFields | Sets private group's custom fields. | |
/api/v1/groups.setDescription | Sets a private group's description. | |
/api/v1/groups.setPurpose | Sets a private group's description. | |
/api/v1/groups.setReadOnly | Sets whether the room is read-only or not. | |
/api/v1/groups.setTopic | Sets a private group's topic. | |
/api/v1/groups.setType | Sets the type of room this group will be. | |
/api/v1/groups.unarchive | Unarchives a private group. | |
/api/v1/groups.setEncrypted | Sets the encryption for a group | |
/api/v1/groups.convertToTeam | Convert a private group to a team |
Url | Short Description | Details Page |
---|---|---|
/api/v1/im.delete | Removes a direct message session | |
/api/v1/im.close | Removes a direct message from the list of direct messages. | |
/api/v1/im.counters | Gets counters of direct messages. | |
/api/v1/im.create | Creates a direct message session with another user. | |
/api/v1/im.history | Retrieves the messages from a direct message. | |
/api/v1/im.files | Retrieves a list of files from a direct message. | |
/api/v1/im.members | Retrieves the users of participants of a direct message. | |
/api/v1/im.messages | Retrieves the messages from the specific direct messages. | |
/api/v1/im.messages.others | Retrieves the messages from any direct message in the server. | |
/api/v1/im.list | Lists the direct messages the caller is part of. | |
/api/v1/im.list.everyone |