README.md

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.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.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
/api/v1/teams.info	Gets a team's information.	Link
/api/v1/teams.delete	Removes a team.	Link
/api/v1/teams.autocomplete	Lists the teams whose names match a given pattern.	Link
/api/v1/teams.update	Updates an existing team (name and type).	Link

Directory

Url	Short Description	Details Page
/api/v1/directory	Searches by all users and channels available on server.	Link

Messaging

Chat

URL	Short Description	Details Page
/api/v1/chat.delete	Deletes an existing chat message.	Link
/api/v1/chat.followMessage	Follows an existing chat message.	Link
/api/v1/chat.getDeletedMessages	Retrieves the deleted messages from a specific date.	Link
/api/v1/chat.getDiscussions	Retrieves the discussions of a room.	Link
/api/v1/chat.getMentionedMessages	Retrieves the mentioned messages.	Link
/api/v1/chat.getMessage	Retrieves a single chat message.	Link
/api/v1/chat.getMessageReadReceipts	Retrieves message read receipts.	Link
/api/v1/chat.getPinnedMessages	Retrieves pinned messages from a room.	Link
/api/v1/chat.getSnippetedMessages	Retrieves snippet messages.	Link
/api/v1/chat.getSnippetedMessageById	Retrieves snippet message by id.	Link
/api/v1/chat.getStarredMessages	Retrieves the starred messages.	Link
/api/v1/chat.getThreadMessages	Retrieves thread's messages.	Link
/api/v1/chat.getThreadsList	Retrieves channel's threads.	Link
/api/v1/chat.ignoreUser	Ignores abuser from a chat.	Link
/api/v1/chat.pinMessage	Pins a chat message to the message's channel.	Link
/api/v1/chat.postMessage	Posts a new chat message.	Link
/api/v1/chat.react	Sets/unsets the user's reaction to an existing chat message.	Link
/api/v1/chat.reportMessage	Reports a message.	Link
/api/v1/chat.search	Searches for messages in a channel.	Link
/api/v1/chat.starMessage	Stars a chat message for the authenticated user.	Link
/api/v1/chat.sendMessage	Sends a new chat message.	Link
/api/v1/chat.syncThreadMessages	Retrieves synced thread's messages.	Link
/api/v1/chat.syncThreadsList	Retrieves thread's synced channel threads.	Link
/api/v1/chat.unfollowMessage	Unfollows an existing chat message.	Link
/api/v1/chat.unPinMessage	Removes the pinned status of the provided chat message.	Link
/api/v1/chat.unStarMessage	Removes the star on the chat message for the authenticated user.	Link
/api/v1/chat.update	Updates the text of the chat message.	Link
/api/v1/chat.syncMessages	Syncs messages	Link

DM/IM

URL	Short Description	Details Page
/api/v1/im.delete	Removes a direct message session	Link
/api/v1/im.close	Removes a direct message from the list of messages	Link
/api/v1/im.counters	Gets counters of direct messages	Link
/api/v1/im.create	Creates a direct message session	Link
/api/v1/im.history	Retrieves messages from a direct message	Link
/api/v1/im.files	Retrieves a list of files from a direct message	Link
/api/v1/im.members	Retrieves participants of a direct message	Link
/api/v1/im.messages	Retrieves messages from specific direct messages	Link
/api/v1/im.messages.others	Retrieves messages from any direct message	Link
/api/v1/im.list	Lists direct messages the caller is part of	Link
/api/v1/im.list.everyone	Lists all direct messages to the caller	Link
/api/v1/im.open	Adds direct message back to the list of messages	Link
/api/v1/im.setTopic	Sets a direct message topic	Link

{% hint style="info" %} From version 0.50.0 and on, you can call the methods using dm instead of im. {% endhint %}

Omnichannel

Livechat

Livechat Agent

Url	Short Description	Details Page
livechat/agent.info/:rid/:token	Retrieves the current omnichannel agent data	Link
livechat/agent.next/:token	Retrieves the data of the next available agent	Link

Livechat Configuration

Url	Short Description	Details Page
livechat/config	Retrieves LiveChat widget configuration info and additional visitor data.	Link

Livechat Contacts

Url	Short Description	Details Page
omnichannel/contact	Registers a guest user as a new omnichannel contact	Link
omnichannel/contact	Retrieves a contact information	Link
omnichannel/contact.search	Searches a contact information	Link

Livechat Custom Field

Url	Short Description	Details Page
livechat/custom.field	Sends a custom field	Link
livechat/custom.fields	Sends an array of custom field	Link
livechat/custom-fields	Retrieves a list of omnichannel custom fields	Link
livechat/custom-fields/:_id	Retrieves info about a custom field	Link

Livechat Message

Url	Short Description	Details Page
livechat/message	Sends a new omnichannel message	Link
livechat/message/:_id	Retrieves a specific message	Link
livechat/message/:_id	Updates an omnichannel message	Link
livechat/message/:_id	Removes an omnichannel message	Link
livechat/messages.history/:rid	Retrieves omnichannel messages history	Link
livechat/messages	Sends array of messages	Link

Livechat Offline Message

Url	Short Description	Details Page
livechat/offline.message	Sends an offline message when no agent is available	Link

Livechat Page Visited

Url	Short Description	Details Page
livechat/page.visited	Retrieves the pages your omnichannel user navigated on your website.	Link

Livechat Room

Url	Short Description	Details Page
livechat/room	Retrievesthe omnichannel room data or open a new conversation.	Link
livechat/room.close	Closes an omnichannel conversation	Link
livechat/room.transfer	Transfers an omnichannel conversation	Link
livechat/room.forward	Chatbot agent forwards the chat to a human agent	Link
livechat/room.visitor	Updates room visitor's information	Link
livechat/room.saveInfo	Update a LiveChat room information.	Link

Livechat Transcript

Url	Short Description	Details Page
livechat/transcript	Send Livechat Transcript to Visitor	Link
/api/v1/livechat/transcript/:rid	Request Livechat transcript	Link
/api/v1/livechat/transcript/:rid	Delete Livechat Transcript Request	Link
omnichannel/:rid/request-transcript	Request PDF Transcript	Link

Livechat Transfer

Url	Short Description	Details Page
livechat/transfer.history/:rid	Retrieves the conversation transfer history	Link

Livechat Visitor

Url	Short Description	Details Page
livechat/visitor	Registers a new visitor	Link
livechat/visitor/:token	Retrieves a visitor	Link
livechat/visitor/:token	Deletes a visitor	Link
livechat/visitor/:token/room	Retrieves open conversation of a visitor	Link
livechat/visitor.status	Sets visitor status	Link

Livechat Agent Stats

Url	Short Description	Details Page
api/v1/livechat/agents/:agentId/departments	Returns all the departments associated with an agent	Link
api/v1/livechat/analytics/agents/average-service-time	Retrieves average service time per agent	Link
api/v1/livechat/analytics/agents/total-service-time	Retrieves total service time sorted by agent	Link
api/v1/livechat/analytics/agents/available-for-service-history	Retrieves a list of agents and their available time for the provided time frame	Link

Livechat Appearance

Url	Short Description	Details Page
api/v1/livechat/appearance	Retrieves LiveChat widget appearance settings	Link
api/v1/livechat/appearance	Update Livechat widget appearance settings.	Link

Livechat Statistics

Url	Short Description	Details Page
/api/v1/livechat/analytics/overview	Get omnichannel analytics overview	Link
/api/v1/livechat/analytics/agent-overview	Get Agent Analytics Overview	Link

Livechat Business Hours

Url	Short Description	Details Page
api/v1/livechat/business-hour	Fetches the default business hours of a workspace	Link
api/v1/livechat/business-hours	Retrieves all the business hours attached to a workspace	Link
api/v1/livechat/business-hours.list	Retrieves a list of existing business hours	Link

Livechat Dashboards

Url	Short Description	Details Page
api/v1/livechat/analytics/dashboards/conversation-totalizers	Retrieves conversation totalizers for a department	Link
api/v1/livechat/analytics/dashboards/agents-productivity-totalizers	Retrieves agent productivity totalizer for a department	Link
api/v1/livechat/analytics/dashboards/chats-totalizers	Retrieves chat totalizers for a department	Link
api/v1/livechat/analytics/dashboards/productivity-totalizers	Retrieves productivity totalizers for a department	Link
api/v1/livechat/analytics/dashboards/charts/chats	Retrieves chats chart for a department	Link
api/v1/livechat/analytics/dashboards/charts/chats-per-agent	Retrieves chats per agent for a department chart	Link
api/v1/livechat/analytics/dashboards/charts/agents-status	Retrieves agent's statuses chart	Link
api/v1/livechat/analytics/dashboards/charts/chats-per-department	Retrieves chats per department chart	Link
api/v1/livechat/analytics/dashboards/charts/timings	Retrieves timing charts	Link

Livechat Departments

Url	Short Description	Details Page
api/v1/livechat/department	Retrieves a list of departments	Link
api/v1/livechat/department	Registers a new department	Link
api/v1/livechat/department/:_id	Retrieves a department's info	Link
api/v1/livechat/department/:_id	Updates a department	Link
api/v1/livechat/department/:_id	Removes a department	Link
api/v1/livechat/department.autocomplete	Autocompletes department name	Link
api/v1/livechat/department/:departmentId/agents	Retrieves agents of a specific department	Link
api/v1/livechat/department/:departmentId/agents	Updates agents of a department	Link
api/v1/livechat/department.listByIds	Retrieves a list of departments by an array of department ids	Link
api/v1/livechat/departments.available-by-unit/:unitId	Retrieves departments available by unit Id	Link
api/v1/livechat/analytics/departments/amount-of-chats	Retrieves the number of incoming chats	Link
api/v1/livechat/analytics/departments/average-service-time	Retrieves average service time	Link
api/v1/livechat/analytics/departments/average-chat-duration-time	Retrieves average chats duration	Link
api/v1/livechat/analytics/departments/total-service-time	Retrieves total service time	Link
api/v1/livechat/analytics/departments/average-waiting-time	Retrieves avg waiting time	Link
api/v1/livechat/analytics/departments/total-transferred-chats	Retrieves total transferred chats	Link
api/v1/livechat/analytics/departments/total-abandoned-chats	Retrieves abandoned chats	Link
api/v1/livechat/analytics/departments/percentage-abandoned-chats	Retrieves percentage of abandoned chats	Link

Livechat Inquiries

Url	Short Description	Details Page
api/v1/livechat/inquiries.list	Lists all of the open livechat inquiries	Link
api/v1/livechat/inquiries.take	Takes an open inquiry	Link
api/v1/livechat/inquiries.queued	Lists queued inquiries	Link
api/v1/livechat/inquiries.getOne	Gets one inquiry by room id	Link
api/v1/livechat/inquiry.prioritize	Sets the priority of an inquiry	Link
api/v1/livechat/inquiry.setSLA	Set SLA to an inquiry.	Link

Livechat Integrations

Url	Short Description	Details Page
api/v1/livechat/integrations.settings	Retrieves a list of integration settings	Link

Livechat Queue

Url	Short Description	Details Page
api/v1/livechat/queue	Retrieves the queued chats	Link

Livechat Rooms

Url	Short Description	Details Page
api/v1/livechat/rooms	Retrieves a list of livechat rooms	Link
api/v1/livechat/room/:rid/priority	Set the priority of a Livechat room.	Link
api/v1/livechat/room/:rid/priority	Remove the priority set to a Livechat room.	Link
api/v1/livechat/room.onHold	Puts an active livechat conversation on hold	Link

Livechat SMS

Url	Short Description	Details Page
api/v1/livechat/sms-incoming/:service	Receives SMS	Link

Livechat Triggers

Url	Short Description	Details Page
api/v1/livechat/triggers	Lists all Livechat triggers	Link
api/v1/livechat/triggers/:_id	Retrieves a Livechat Trigger by id	Link

Livechat Upload

Url	Short Description	Details Page
api/v1/livechat/upload/:rid	Uploads files on livechat room.	Link

Livechat Users

Url	Short Description	Details Page
api/v1/livechat/users/:type	Gets a list of agents or managers	Link
api/v1/livechat/users/:type	Registers a new agent or manager	Link
api/v1/livechat/users/:type/:_id	Gets info about an agent or manager	Link
api/v1/livechat/users/:type/:_id	Removes an agent or manager	Link

Livechat Visitors

Url	Short Description	Details Page
api/v1/livechat/visitors.info	Retrieves visitor info by ID	Link
api/v1/livechat/visitors.pagesVisited/:roomId	Retrieves pages visited by livechat visitor	Link
api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId	Retrieves livechat visitor's chat history	Link
api/v1/livechat/visitors.searchChats/room/:roomId/visitor/:visitorId	Searches a visitor's chat	Link
api/v1/livechat/visitors.autocomplete	Autocompletes visitor's name	Link
api/v1/livechat/visitors.search	Searches the visitor by the term	Link

Livechat Monitors

Url	Short Description	Details Page
api/v1/livechat/monitors	List all monitors	Link
api/v1/livechat/monitors/:username	Get a Monitor	Link

Livechat Priorities

Url	Short Description	Details Page
api/v1/livechat/priorities	Get priorities	Link
api/v1/livechat/priorities/:priorityId	Get a priority	Link
api/v1/livechat/priorities/:priorityId	Update the priority	Link
api/v1/livechat/priorities.reset	Reset the priority	Link

Livechat Tags

Url	Short Description	Details Page
api/v1/livechat/tags	Retrieves a list of tags	Link
livechat/tags/:tagId	Get a tag.	Link

Livechat Units

Url	Short Description	Details Page
api/v1/livechat/units	Create unit	Link
api/v1/livechat/units	List all omnichannel units.	Link
api/v1/livechat/units/:unitId	Retrieves details of a unit	Link
api/v1/livechat/units/:unitId/monitors	List unit monitors	Link
api/v1/livechat/units/:id	Update Unit by Id	Link
api/v1/livechat/units/:id	Delete unit using ID	Link

Voice Channel

URL	Description	Details Page
/v1/connector.extension.getRegistrationInfoByUserId	Get registration information by ID	Link
/api/v1/voip/queues.getSummary	Get VoIP query summary data	Link
/api/v1/voip/queues.getSummary	Get VoIP query summary data	Link
/api/v1/voip/queues.getSummary	Get VoIP queue membership data	Link
/v1/voip/queues.getMembershipSubscription	Get VoIP queue membership subscription data	Link
/v1/voip/queues.getMembershipSubscription	Get VoIP queue membership subscription data	Link
v1/voip/queues.getMembershipSubscription	Get the VoIP queue membership subscription data	Link
api/v1/livechat/visitor	Create a VoIP visitor	Link
/api/v1/voip/events	Send VoIP events	Link
/api/v1/omnichannel/extension	Retrieve VoIP extension information	Link
/api/v1/omnichannel/extensions?count=10&offset=10	Retrieve VoIP extensions	Link
/v1/omnichannel/agent/extension	Create, update and delete VoIP extension	Link
/api/v1/voip/managementServer/checkConnection?host&port&username&password	Check management server connection status	Link
/api/v1/voip/callServer/checkConnection?websocketUrl=wss://omni-asterisk.dev.rocket.chat/ws	Check call server connection status	Link
/api/v1/voip/room?token=867ad6a09fc4af29f6f1f2a9cf1deaba&agentId=6vHSSqdBHdm2R4gfi	Create VoIP room	Link
/api/v1/voip/events	Retrieve VoIP room information by ID	Link
/api/v1/voip/room.clos	Close the VoIP conversation	Link

Canned Response

URL	Short Description	Details Page
/api/v1/canned-responses	Create a canned response.	Link
/api/v1/canned-responses	Update a canned response.	Link
/api/v1/canned-responses/:_id	Get a canned response	Link
/api/v1/canned-responses	List all canned responses	Link
/api/v1/canned-responses.get	Get user canned responses	Link
/api/v1/canned-responses	Remove a canned response	Link

Integrations

Integration

Url	Short Description	Details Page
/api/v1/integrations.create	Creates an integration.	Link
/api/v1/integrations.get	Gets an integration.	Link
/api/v1/integrations.history	Lists all history of the specified integration.	Link
/api/v1/integrations.list	Lists all of the integrations.	Link
/api/v1/integrations.remove	Removes an integration.	Link
/api/v1/integrations.update	Updates an integration.	Link

Webdav

URL	Short Description	Details Page
/api/v1/webdav.getMyAccounts	Retrieves the user's webdav accounts	Link

OAuth App

Url	Short Description	Details Page
/api/v1/oauth-apps.get	Retrieves an OAuth App by id or client id.	Link
/api/v1/oauth-apps.list	Retrieves a list of OAuth Apps.	Link

Notifications

Banners

URL	Short Description	Details Page
/api/v1/banners/:id	Gets the banners to be shown to the authenticated user	Link
/api/v1/banners	Gets the banners to be shown to the authenticated user	Link
/api/v1/banners.dismiss	Dismisses a banner	Link

Push

Url	Short Description	Details Page
/api/v1/push.token	Saves push token.	Link
/api/v1/push.token	Removes push token.	Link
/api/v1/push.get	Get push notification for a message	Link

Content Management

Assets

URL	Short Description	Details Page
/api/v1/assets.setAsset	Sets an asset image by name.	Link
/api/v1/assets.unsetAsset	Unsets an asset by name.	Link

Custom Emoji

Url	Short Description	Details Page
/api/v1/emoji-custom.all	Retrieves all custom emojis	Link
/api/v1/emoji-custom.list	Retrieves an updated list of custom emojis	Link
/api/v1/emoji-custom.create	Creates new custom emoji.	Link
/api/v1/emoji-custom.delete	Delete an existent custom emoji.	Link
/api/v1/emoji-custom.update	Updates an existent custom emoji.	Link

Custom Sounds

URL	Short Description	Details Page
/api/v1/custom-sounds.list	Retrieves a list of custom sounds.	Link

Custom User Status

URL	Short Description	Details Page
/api/v1/custom-user-status.list	Lists all available custom user's status.	Link
/api/v1/custom-user-status.create	Creates custom user status	Link
/api/v1/custom-user-status.delete	Deletes a custom user status	Link
/api/v1/custom-user-status.update	Updates a custom user status	Link

Statistics

Stats

URL	Short Description	Details Page
/api/v1/statistics	Retrieves statistics	Link
/api/v1/statistics.list	Retrieves statistics list	Link

Engagement Dashboard

Users Engagement Dashboard Endpoints

Url	Short Description	Details Page
/api/v1/engagement-dashboard/users/new-users	List new users during a specific period	Link
/api/v1/engagement-dashboard/users/active-users	List active users in the workspace	Link
/api/v1/engagement-dashboard/users/users-by-time-of-the-day-in-a-week	List users by hours at a particular time of the day in a week	Link
/api/v1/engagement-dashboard/users/chat-busier/hourly-data	Get hourly data when chat is busier	Link
/api/v1/engagement-dashboard/users/chat-busier/weekly-data	Get weekly data when chat is busier	Link

Messages Engagement Dashboard Endpoints

URL	Short Description	Details Page
/api/v1/engagement-dashboard/messages/messages-sent	Get number of daily messages sent during a period	Link
/api/v1/engagement-dashboard/messages/origin	Get origin of messages sent during a period	Link
/api/v1/engagement-dashboard/messages/top-five-popular-channels	Get top 5 popular channels by message count	Link

Channels Engagement Dashboard Endpoints

URL	Short Description	Details Page
api/v1/engagement-dashboard/channels/list	Get all channels and the number of messages in each	Link

Subscription

Url	Short Description	Details Page
/api/v1/subscriptions.get	Retrieves all subscriptions.	Link
/api/v1/subscriptions.getOne	Retrieves the subscription by room Id.	Link
/api/v1/subscriptions.read	Marks a room as read.	Link
/api/v1/subscriptions.unread	Marks messages as unread.	Link

Settings

Settings

You can get and update the settings via the REST API, only if you have permission to.

Url	Short Description	Details Page
/api/v1/settings	Lists all private settings.	Link
/api/v1/settings.public	Lists all public settings.	Link
/api/v1/settings.oauth	Returns list of all available oauth services.	Link
/api/v1/service.configurations	Lists all service configurations.	Link
/api/v1/settings/:_id	Retrieves a setting.	Link
/api/v1/settings/:_id	Updates a setting.	Link

Cloud

URL	Short Description	Details Page
/api/v1/cloud.manualRegister	Manually registers a workspace	Link

DNS

URL	Short Description	Details Page
/api/v1/dns.resolve.srv	Resolves DNS srv records (SRV records) for a hostname	Link
/api/v1/dns.resolve.txt	Resolves DNS text records (TXT records) for a hostname	Link

E2E

URL	Short Description	Details Page
/api/v1/e2e.fetchMyKeys	Retrieves E2E keys of logged in user	Link
/api/v1/e2e.getUsersOfRoomWithoutKey	Retrieves Users Of Room Without E2E Key	Link
/api/v1/e2e.setRoomKeyID	Sets the end-to-end encryption key ID for a room	Link
/api/v1/e2e.setUserPublicAndPrivateKeys	Sets the end-to-end encryption keys for the authenticated user.	Link
/api/v1/e2e.updateGroupKey	Updates the end-to-end encryption key for a user in a room.	Link

Imports

URL	Short Description	Details Page
/api/v1/uploadImportFile	Upload import file.	Link
/api/v1/downloadPublicImportFile	Download public import file.	Link
/api/v1/startImport	Start import.	Link
/api/v1/getImportFileData	Get file data of an upload.	Link
/api/v1/getImportProgress	Get the progress of an import.	Link
/api/v1/getLatestImportOperations	Get latest import operations	Link
/api/v1/downloadPendingFiles	Download pending files	Link
/api/v1/downloadPendingAvata	Download pending avatars	Link
/api/v1/getCurrentImportOperation	Gets current import operations	Link

Bulk User Import

Url	Short Description	Details Page
/api/v1/import.addUsers	Adds user data to the import staging area.	Link
/api/v1/import.clear	Abort any import operation currently in progress	Link
/api/v1/import.run	Process the data from the current import operation and create the users on Rocket.Chat	Link
/api/v1/import.new	Creates a new import operation.	Link
/api/v1/import.status	Get the status of the current import operation	Link

Instances

URL	Short Description	Details Page
/api/v1/instances.get	Retrieves instances	Link

Federation

Url	Short Description	Details Page
api/v1/federation/addServerByUser	Adds a server to search public rooms later	Link
api/v1/federation/listServersByUser	Retrieves all the server names saved by the user	Link
api/v1/federation/removeServerByUser	Remove a server name	Link
api/v1/federation/searchPublicRooms	Returns all the public room given a server name	Link
api/v1/joinExternalPublicRoom	Joins an External public Matrix room	Link

Device Management

URL	Short Description	Details Page
/api/v1/sessions/list	Retrieves all sessions of the authenticated user	Link
/api/v1/sessions/list.all	Retrieve the sessions of all users on the workspace	Link
/api/v1/sessions/info	Get user's session	Link
/api/v1/sessions/logout.me	Logout the authenticated user from the current session	Link
/api/v1/sessions/logout	Logout of a session	Link

Auto Translate

URL	Short Description	Details Page
/api/v1/autotranslate.getSupportedLanguages	Gets the supported languages by auto-translate.	Link
/api/v1/autotranslate.saveSettings	Saves some settings about auto-translate.	Link
/api/v1/autotranslate.translateMessage	Translates the message.	Link

Commands

URL	Short Description	Details Page
/api/v1/commands.get	Retrieves the specification of the slash command.	Link
/api/v1/commands.list	Lists all available slash commands.	Link
/api/v1/commands.run	Executes a slash command in the specified room.	Link
/api/v1/commands.preview	Retrieves the preview data for the command and executes the preview item.	Link
/api/v1/commands.preview	Executes command's preview item	Link

Email Inbox

URL	Short Description	Details Page
/api/v1/email-inbox.list	Retrieves mail Inbox list	Link
/api/v1/email-inbox	Sets the email inbox for your server	Link
/api/v1/email-inbox/:_id	Retrieves email Inbox by id	Link
/api/v1/email-inbox/:_id	Delete email inbox using id	Link
/api/v1/email-inbox.search	Searches email inbox by address	Link
/api/v1/email-inbox.send-test/:_id	Sends test email to email inbox	Link

Invite

Url	Short Description	Details Page
/api/v1/findOrCreateInvite	Created a new Invite or returns an existing one with the same parameters.	Link
/api/v1/listInvites	Lists all of the invite tokens.	Link
/api/v1/removeInvite/:_id	Deletes an invite from the server.	Link
/api/v1/useInviteToken	Reports to the server that an invite token was used.	Link
/api/v1/validateInviteToken	Checks if an invite token is valid.	Link

Licenses

Url	Short Description	Details Page
/api/v1/licenses.get	Gets all registered licenses.	Link
/api/v1/licenses.isEnterprise	Confirm if workspace has enterprise license.	Link
licenses.maxActiveUsers	Get maximum active users.	Link

Video conference

URL	Short Description	Details Page
/api/v1/video-conference/jitsi.update-timeout	Updates the timeout of Jitsi video conference in a channel.	Link

Others

URL	Short Description	Details Page
/api/apps	Install a private app via URL	Link
/api/v1/shield.svg	Get the the shield svg(badge)	Link
/api/v1/spotlight	Searches for users or rooms that are visible to the user	Link
/api/v1/stdout.queue	Retrieves last 1000 lines of server logs	Link

WhatsApp

Description	Details Page
WhatsApp Business API integration for Rocket.Chat	Link
Send a template message.	Link

Mailer

URL	Short Description	Details Page
/api/v1/mailer	Send an email to users on your workspace.	Link
/api/v1/mailer.subscribe	Unsubscribe from mailer	Link

Moderation

Url	Short Description	Details Page
/api/v1/moderation.reportsByUsers	Retrieves all the reported messages grouped by users	Link
/api/v1/moderation.user.reportedMessages	Retrieve all reported messages of a user.	Link
/api/v1/moderation.reports	Retrieve all the reports of a single message	Link
/api/v1/moderation.reportInfo	Get more details of a single report.	Link
/api/v1/moderation.dismissReports	Dismiss all the reports of a particular user.	Link
/api/v1/moderation.user.deleteReportedMessages	Delete all the reports of messages that belongs to user.	Link