Links

Endpoints

Authentication

Url
Short Description
Details Page
/api/v1/login
Authenticate with username and password.
Link
/api/v1/login
Authenticate with facebook.
Link
/api/v1/login
Authenticate with google.
Link
/api/v1/login
Authenticate with twitter.
Link
/api/v1/logout
Invalidate your REST API authentication token.
Link
/api/v1/me
Displays information about the authenticated user.
Link

User Management

Avatar

URL
Short Description
Details Page
/avatar/{subject}
Fetch room avatar
Link

Users

URL
Short Description
Details Page
/api/v1/users.create
Creates a new user
Link
/api/v1/users.delete
Deletes an existing user
Link
/api/v1/users.deleteOwnAccount
Deletes your own user
Link
/api/v1/users.getAvatar
Gets the URL for a user’s avatar
Link
/api/v1/users.setActiveStatus
Sets user's active status
Link
/api/v1/users.deactivateIdle
Deactivates Idle users
Link
/api/v1/users.getPresence
Gets a user's presence
Link
/api/v1/users.info
Retrieves information about a user
Link
/api/v1/users.list
Retrieves all of the users
Link
/api/v1/users.register
Registers users
Link
/api/v1/users.resetAvatar
Resets avatar
Link
/api/v1/users.setAvatar
Sets avatar
Link
/api/v1/users.getStatus
Gets a user's status
Link
/api/v1/users.setStatus
Sets a user status
Link
/api/v1/users.update
Updates user
Link
/api/v1/users.updateOwnBasicInfo
Updates own basic information
Link
/api/v1/users.createToken
Creates a user authentication token
Link
/api/v1/users.getPreferences
Gets all preferences of the user
Link
/api/v1/users.setPreferences
Sets preferences of the user
Link
/api/v1/users.forgotPassword
Sends an email to reset your password
Link
/api/v1/users.getUsernameSuggestion
Suggestion of new username to user
Link
/api/v1/users.generatePersonalAccessToken
Generates Personal Access Token
Link
/api/v1/users.regeneratePersonalAccessToken
Regenerates a user's personal access token
Link
/api/v1/users.getPersonalAccessTokens
Gets the user’s personal access tokens
Link
/api/v1/users.removePersonalAccessToken
Removes a personal access token
Link
/api/v1/users.2fa.enableEmail
Enables 2fa email
Link
/api/v1/users.2fa.disableEmail
Disables 2fa email
Link
/api/v1/users.2fa.sendEmailCode
Sends 2fa code
Link
/api/v1/users.presence
Gets all connected users presence
Link
/api/v1/users.requestDataDownload
Requests the user's data for download
Link
/api/v1/users.logoutOtherClients
Logs out other clients
Link
/api/v1/users.autocomplete
Lists the user whose names match a given pattern
Link
/api/v1/users.removeOtherTokens
Removes other tokens
Link
/api/v1/users.resetE2EKey
Reset the E2E key for a user
Link
/api/v1/users.resetTOTP
Reset the Two-factor authentication via TOTP
Link
/api/v1/users.listTeams
Lists users teams
Link
/api/v1/users.logout
Logs user out
Link
/api/v1/moderation.reportUser
Report a user.
Link

LDAP

Url
Short Description
Details Page
/api/v1/ldap.syncNow
LDAP SyncNow
Link

Permissions

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

Roles

Url
Short Description
Details Page
/api/v1/roles.list
Lists all roles on the server
Link
/api/v1/roles.sync
Lists all roles on the server updated after a date
Link
/api/v1/roles.create
Creates a new role
Link
/api/v1/roles.addUserToRole
Edits permissions on the server
Link
/api/v1/roles.getUsersInRole
Retrieves users that belong to a role
Link
/api/v1/roles.update
Updates an existing role in the system
Link
/api/v1/roles.delete
Deletes a role
Link
/api/v1/roles.removeUserFromRole
Unassigns a role from a user
Link

Rooms

Group

Url
Short Description
Details Page
/api/v1/groups.addAll
Adds all users to a private group
Link
/api/v1/groups.addLeader
Gives Leader role to a user in the current group
Link
/api/v1/groups.addModerator
Gives moderator role to a user in a group
Link
/api/v1/groups.addOwner
Gives owner role 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
Retrieves 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
Retrieves files from a private group
Link
/api/v1/groups.getIntegrations
Retrieves integrations assigned to the group
Link
/api/v1/groups.history
Retrieves messages from a private group
Link
/api/v1/groups.info
Retrieves 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 caller from the private group
Link
/api/v1/groups.list
Lists private groups the caller is part of
Link
/api/v1/groups.listAll
Lists all private groups
Link
/api/v1/groups.moderators
Lists moderators of a group
Link
/api/v1/groups.members
Retrieves users of a private group
Link
/api/v1/groups.membersByHighestRole
Retrieves users of a private group sorted by their most important room role
Link
/api/v1/groups.messages
Retrieves all group messages
Link
/api/v1/groups.online
Lists 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 Leader role from a user in the current group
Link
/api/v1/groups.removeModerator
Removes moderator role from a user in a group
Link
/api/v1/groups.removeOwner
Removes owner role from a user in a group
Link
/api/v1/groups.rename
Changes the name of the private group
Link
/api/v1/groups.roles
Retrieves 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 purpose
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
Sets the encryption for a group
Link
/api/v1/groups.convertToTeam
Converts a private group to a team
Link

Channels

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
Link
/api/v1/channels.addLeader
Gives Leader role to a user in the current channel
Link
/api/v1/channels.addModerator
Gives moderator role to a user in a channel
Link
/api/v1/channels.addOwner
Gives owner role to a user in a channel
Link
/api/v1/channels.anonymousread
Gets messages in public channels for an anonymous user
Link
/api/v1/channels.archive
Archives a channel
Link
/api/v1/channels.close
Removes a channel from a user's list
Link
/api/v1/channels.counters
Retrieves channel counters
Link
/api/v1/channels.create
Creates a new channel
Link
/api/v1/channels.delete
Removes a channel
Link
/api/v1/channels.getAllUserMentionsByChannel
Retrieves mentions of a channel
Link
/api/v1/channels.files
Retrieves files from a channel
Link
/api/v1/channels.getIntegrations
Retrieves channel integrations
Link
/api/v1/channels.history
Retrieves messages from a channel
Link
/api/v1/channels.info
Gets channel information
Link
/api/v1/channels.invite
Adds a user to a channel
Link
/api/v1/channels.join
Joins a channel
Link
/api/v1/channels.kick
Removes a user from a channel
Link
/api/v1/channels.leave
Removes the caller from a channel
Link
/api/v1/channels.list
Retrieves all channels from the server
Link
/api/v1/channels.list.joined
Retrieves joined channels of the calling user
Link
/api/v1/channels.members
Retrieves all channel users
Link
/api/v1/channels.membersByHighestRole
Retrieves all channel users sorted by their most important room role
Link
/api/v1/channels.messages
Retrieves all channel messages
Link
/api/v1/channels.moderators
Lists all moderators of a channel
Link
/api/v1/channels.online
Lists all online users of a channel
Link
/api/v1/channels.open
Adds the channel back to the user's list
Link
/api/v1/channels.removeleader
Removes Leader role from a user in the current channel
Link
/api/v1/channels.removeModerator
Removes moderator role from a user in a channel
Link
/api/v1/channels.removeOwner
Removes owner role from a user in a channel
Link
/api/v1/channels.rename
Changes a channel's name
Link
/api/v1/channels.roles
Gets 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 join code
Link
/api/v1/channels.setPurpose
Sets a channel's purpose
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
Converts channel to team
Link

Room

Url
Short Description
Details Page
/api/v1/rooms.adminRooms
Retrieves all rooms (requires special permission).
Link
/api/v1/rooms.cleanHistory
Cleans up a room's history, requires special permission.
Link
/api/v1/rooms.createDiscussion
Creates a new discussion.
Link
/api/v1/rooms.favorite
Favorites/Unfavorites room.
Link
/api/v1/rooms.get
Retrieves rooms.
Link
/api/v1/rooms.getDiscussions
Retrieves room's discussions.
Link
/api/v1/rooms.info
Gets info from a room.
Link
/api/v1/rooms.leave
Leaves a room.
Link
/api/v1/rooms.saveNotification
Sets the notification settings of a specific channel.
Link
/api/v1/rooms.upload/:rid
Uploads a message with the attached file.
Link
/api/v1/rooms.adminRooms.getRoom
Retrieves all admin rooms
Link
/api/v1/rooms.autocomplete.channelAndPrivate
Autocompletes private channel
Link
/api/v1/rooms.autocomplete.availableForTeams
Autocompletes room name available for conversion to team
Link
/api/v1/rooms.saveRoomSettings
Save the settings of a room
Link
/api/v1/rooms.changeArchivationState
Change the Archive state of a room.
Link
/api/v1/rooms.export
Export room to a file or email.
Link

Teams

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
Converts team to channel.
Link
/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