Endpoints

Authentication

UrlShort DescriptionDetails 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.

User Management

Avatar

URLShort DescriptionDetails Page

/avatar/{subject}

Fetch room avatar

Users

URLShort DescriptionDetails 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.

LDAP

UrlShort DescriptionDetails Page

/api/v1/ldap.syncNow

LDAP SyncNow

Permissions

UrlShort DescriptionDetails Page

/api/v1/permissions.listAll

Lists permissions on the server.

/api/v1/permissions.update

Edits permissions on the server.

Roles

UrlShort DescriptionDetails 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

Rooms

Group

UrlShort DescriptionDetails 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.membersByHighestRole

Retrieves users of a private group sorted by their most important room role

Link

/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

Channels

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

URLShort DescriptionDetails 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.membersByHighestRole

Retrieves all channel users sorted by their most important room role

Link

/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

Room

UrlShort DescriptionDetails 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.

Teams

UrlShort DescriptionDetails 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.

/api/v1/teams.update

Updates an existing team (name and type).

Directory

UrlShort DescriptionDetails Page

/api/v1/directory

Searches by all users and channels available on server.

Messaging

Chat

URLShort DescriptionDetails 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

DM/IM

URLShort DescriptionDetails Page

/api/v1/im.delete

Removes a direct message session

/api/v1/im.close

Removes a direct message from the list of messages

/api/v1/im.counters

Gets counters of direct messages

/api/v1/im.create

Creates a direct message session

/api/v1/im.history

Retrieves messages from a direct message

/api/v1/im.files

Retrieves a list of files from a direct message

/api/v1/im.members

Retrieves participants of a direct message

/api/v1/im.messages

Retrieves messages from specific direct messages

/api/v1/im.messages.others

Retrieves messages from any direct message

/api/v1/im.list

Lists direct messages the caller is part of

/api/v1/im.list.everyone

Lists all direct messages to the caller

/api/v1/im.open

Adds direct message back to the list of messages

/api/v1/im.setTopic

Sets a direct message topic

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

Omnichannel

Livechat

Livechat Agent

UrlShort DescriptionDetails Page

livechat/agent.info/:rid/:token

Retrieves the current omnichannel agent data

livechat/agent.next/:token

Retrieves the data of the next available agent

Livechat Configuration

UrlShort DescriptionDetails Page

livechat/config

Retrieves LiveChat widget configuration info and additional visitor data.

Livechat Contacts

UrlShort DescriptionDetails Page

omnichannel/contact

Registers a guest user as a new omnichannel contact

omnichannel/contact

Retrieves a contact information

omnichannel/contact.search

Searches a contact information

Livechat Custom Field

UrlShort DescriptionDetails Page

livechat/custom.field

Sends a custom field

livechat/custom.fields

Sends an array of custom field

livechat/custom-fields

Retrieves a list of omnichannel custom fields

livechat/custom-fields/:_id

Retrieves info about a custom field

Livechat Message

UrlShort DescriptionDetails Page

livechat/message

Sends a new omnichannel message

livechat/message/:_id