Endpoints
Url | Short Description | Details Page |
|---|---|---|
/api/v1/login | Authenticate with username and password. | |
/api/v1/login | Authenticate with facebook. | |
/api/v1/login | Authenticate with google. | |
/api/v1/login | Authenticate with twitter. | |
/api/v1/logout | Invalidate your REST API authentication token. | |
/api/v1/me | Displays information about the authenticated user. |
URL | Short Description | Details Page |
|---|---|---|
/avatar/{subject} | Fetch room avatar |
URL | Short Description | Details Page |
|---|---|---|
/api/v1/users.create | Creates a new user | |
/api/v1/users.delete | Deletes an existing user | |
/api/v1/users.deleteOwnAccount | Deletes your own user | |
/api/v1/users.getAvatar | Gets the URL for a user’s avatar | |
/api/v1/users.setActiveStatus | Sets user's active status | |
/api/v1/users.deactivateIdle | Deactivates Idle users | |
/api/v1/users.getPresence | Gets a user's presence | |
/api/v1/users.info | Retrieves information about a user | |
/api/v1/users.list | Retrieves all of the users | |
/api/v1/users.register | Registers users | |
/api/v1/users.resetAvatar | Resets avatar | |
/api/v1/users.setAvatar | Sets avatar | |
/api/v1/users.getStatus | Gets a user's status | |
/api/v1/users.setStatus | Sets a user status | |
/api/v1/users.update | Updates user | |
/api/v1/users.updateOwnBasicInfo | Updates own basic information | |
/api/v1/users.createToken | Creates a user authentication token | |
/api/v1/users.getPreferences | Gets all preferences of the user | |
/api/v1/users.setPreferences | Sets preferences of the user | |
/api/v1/users.forgotPassword | Sends an email to reset your password | |
/api/v1/users.getUsernameSuggestion | Suggestion of new username to user | |
/api/v1/users.generatePersonalAccessToken | Generates Personal Access Token | |
/api/v1/users.regeneratePersonalAccessToken | Regenerates a user's personal access token | |
/api/v1/users.getPersonalAccessTokens | Gets the user’s personal access tokens | |
/api/v1/users.removePersonalAccessToken | Removes a personal access token | |
/api/v1/users.2fa.enableEmail | Enables 2fa email | |
/api/v1/users.2fa.disableEmail | Disables 2fa email | |
/api/v1/users.2fa.sendEmailCode | Sends 2fa code | |
/api/v1/users.presence | Gets all connected users presence | |
/api/v1/users.requestDataDownload | Requests the user's data for download | |
/api/v1/users.logoutOtherClients | Logs out other clients | |
/api/v1/users.autocomplete | Lists the user whose names match a given pattern | |
/api/v1/users.removeOtherTokens | Removes other tokens | |
/api/v1/users.resetE2EKey | Reset the E2E key for a user | |
/api/v1/users.resetTOTP | Reset the Two-factor authentication via TOTP | |
/api/v1/users.listTeams | Lists users teams | |
/api/v1/users.logout | Logs user out | |
/api/v1/moderation.reportUser | Report a user. |
Url | Short Description | Details Page |
|---|---|---|
/api/v1/ldap.syncNow | LDAP SyncNow |
Url | Short Description | Details Page |
|---|---|---|
/api/v1/roles.list | Lists all roles on the server | |
/api/v1/roles.sync | Lists all roles on the server updated after a date | |
/api/v1/roles.create | Creates a new role | |
/api/v1/roles.addUserToRole | Edits permissions on the server | |
/api/v1/roles.getUsersInRole | Retrieves users that belong to a role | |
/api/v1/roles.update | Updates an existing role in the system | |
/api/v1/roles.delete | Deletes a role | |
/api/v1/roles.removeUserFromRole | Unassigns a role from a user |
Url | Short Description | Details Page |
|---|---|---|
/api/v1/groups.addAll | Adds all users to a private group | |
/api/v1/groups.addLeader | Gives Leader role to a user in the current group | |
/api/v1/groups.addModerator | Gives moderator role to a user in a group | |
/api/v1/groups.addOwner | Gives owner role 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 files from a private group | |
/api/v1/groups.getIntegrations | Retrieves integrations assigned to the group | |
/api/v1/groups.history | Retrieves messages from a private group | |
/api/v1/groups.info | Retrieves 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 caller from the private group | |
/api/v1/groups.list | Lists private groups the caller is part of | |
/api/v1/groups.listAll | Lists all private groups | |
/api/v1/groups.moderators | Lists moderators of a group | |
/api/v1/groups.members | Retrieves users of a private group | |
/api/v1/groups.messages | Retrieves all group messages | |
/api/v1/groups.online | Lists online users of a group | |
/api/v1/groups.open | Adds the private group back to the list of groups | |
/api/v1/groups.removeLeader | Removes Leader role from a user in the current group | |
/api/v1/groups.removeModerator | Removes moderator role from a user in a group | |
/api/v1/groups.removeOwner | Removes owner role from a user in a group | |
/api/v1/groups.rename | Changes the name of the private group | |
/api/v1/groups.roles | Retrieves 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 purpose | |
/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 | Converts a private group to a team |
These methods apply to public channels only. Use
groups.* methods for private channels.URL | Short Description | Details Page |
|---|---|---|
/api/v1/channels.addAll | Adds all users to a channel | |
/api/v1/channels.addLeader | Gives Leader role to a user in the current channel | |
/api/v1/channels.addModerator | Gives moderator role to a user in a channel | |
/api/v1/channels.addOwner | Gives owner role to a user in a channel | |
/api/v1/channels.anonymousread | Gets messages in public channels for an anonymous user | |
/api/v1/channels.archive | Archives a channel | |
/api/v1/channels.close | Removes a channel from a user's list | |
/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 mentions of a channel | |
/api/v1/channels.files | Retrieves files from a channel | |
/api/v1/channels.getIntegrations | Retrieves channel integrations | |
/api/v1/channels.history | Retrieves messages from a channel | |
/api/v1/channels.info | Gets channel information | |
/api/v1/channels.invite | Adds a user to a channel | |
/api/v1/channels.join | Joins a channel | |
/api/v1/channels.kick | Removes a user from a channel | |
/api/v1/channels.leave | Removes the caller from a channel | |
/api/v1/channels.list | Retrieves all channels from the server | |
/api/v1/channels.list.joined | Retrieves joined channels of the calling user | |
/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 | |
/api/v1/channels.removeleader | Removes Leader role from a user in the current channel | |
/api/v1/channels.removeModerator | Removes moderator role from a user in a channel | |
/api/v1/channels.removeOwner | Removes owner role from a user in a channel | |
/api/v1/channels.rename | Changes a channel's name | |
/api/v1/channels.roles | Gets 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 join code | |
/api/v1/channels.setPurpose | Sets a channel's purpose | |
/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/rooms.adminRooms | Retrieves all rooms (requires special permission). | |
/api/v1/rooms.cleanHistory | Cleans up a room's history, requires special permission. | |
/api/v1/rooms.createDiscussion | Creates a new discussion. | |
/api/v1/rooms.favorite | Favorites/Unfavorites room. | |
/api/v1/rooms.get | Retrieves rooms. | |
/api/v1/rooms.getDiscussions | Retrieves room's discussions. | |
/api/v1/rooms.info | Gets info from a room. | |
/api/v1/rooms.leave | Leaves a room. | |
/api/v1/rooms.saveNotification | Sets the notification settings of a specific channel. | |
/api/v1/rooms.upload/:rid | Uploads a message with the attached file. | |
/api/v1/rooms.adminRooms.getRoom | Retrieves all admin rooms | |
/api/v1/rooms.autocomplete.channelAndPrivate | Autocompletes private channel | |
/api/v1/rooms.autocomplete.availableForTeams | Autocompletes room name available for conversion to team | |
/api/v1/rooms.saveRoomSettings | Save the settings of a room | |
/api/v1/rooms.changeArchivationState | Change the Archive state of a room. | |
/api/v1/rooms.export | Export room to a file or email. |
Url | Short Description | Details Page |
|---|---|---|
/api/v1/teams.list | Lists the public and private teams the caller is part of. | |
/api/v1/teams.listAll | Lists all of the teams and their information. | |
/api/v1/teams.create | Creates a new team. | |
/api/v1/teams.convertToChannel | Converts team to channel. | |
/api/v1/teams.addRooms | Adds rooms to the team. | |
/api/v1/teams.removeRoom | Removes a room from a team. | |
/api/v1/teams.updateRoom | Updates a room from a team, limited to permissions. | |
/api/v1/teams.listRooms | Lists all rooms of the team. | |
/api/v1/teams.listRoomsOfUser | Lists only the team's rooms the user has joined. | |
/api/v1/teams.members | Retrieves all team members. | |
/api/v1/teams.addMembers | Adds members to the team. | |
/api/v1/teams.updateMember | Updates a team member's roles, limited to permissions. | |
/api/v1/teams.removeMember | Removes a member from a team. | |
/api/v1/teams.leave | Leaves a team. | |
/api/v1/teams.info | Gets a team's information. | |
/api/v1/teams.delete | Removes a team. | |
/api/v1/teams.autocomplete | Lists the teams whose names match a given pattern. |