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

Retrieves a specific message

livechat/message/:_id

Updates an omnichannel message

livechat/message/:_id

Removes an omnichannel message

livechat/messages.history/:rid

Retrieves omnichannel messages history

livechat/messages

Sends array of messages

Livechat Offline Message

UrlShort DescriptionDetails Page

livechat/offline.message

Sends an offline message when no agent is available

Livechat Page Visited

UrlShort DescriptionDetails Page

livechat/page.visited

Retrieves the pages your omnichannel user navigated on your website.

Livechat Room

UrlShort DescriptionDetails Page

livechat/room

Retrievesthe omnichannel room data or open a new conversation.

livechat/room.close

Closes an omnichannel conversation

livechat/room.transfer

Transfers an omnichannel conversation

livechat/room.forward

Chatbot agent forwards the chat to a human agent

livechat/room.visitor

Updates room visitor's information

livechat/room.saveInfo

Update a LiveChat room information.

Livechat Transcript

UrlShort DescriptionDetails Page

livechat/transcript

Send Livechat Transcript to Visitor

/api/v1/livechat/transcript/:rid

Request Livechat transcript

/api/v1/livechat/transcript/:rid

Delete Livechat Transcript Request

omnichannel/:rid/request-transcript

Request PDF Transcript

Livechat Transfer

UrlShort DescriptionDetails Page

livechat/transfer.history/:rid

Retrieves the conversation transfer history

Livechat Visitor

UrlShort DescriptionDetails Page

livechat/visitor

Registers a new visitor

livechat/visitor/:token

Retrieves a visitor

livechat/visitor/:token

Deletes a visitor

livechat/visitor/:token/room

Retrieves open conversation of a visitor

livechat/visitor.status

Sets visitor status

Livechat Agent Stats

UrlShort DescriptionDetails Page

api/v1/livechat/agents/:agentId/departments

Returns all the departments associated with an agent

api/v1/livechat/analytics/agents/average-service-time

Retrieves average service time per agent

api/v1/livechat/analytics/agents/total-service-time

Retrieves total service time sorted by agent

api/v1/livechat/analytics/agents/available-for-service-history

Retrieves a list of agents and their available time for the provided time frame

Livechat Appearance

UrlShort DescriptionDetails Page

api/v1/livechat/appearance

Retrieves LiveChat widget appearance settings

api/v1/livechat/appearance

Update Livechat widget appearance settings.

Livechat Statistics

UrlShort DescriptionDetails Page

/api/v1/livechat/analytics/overview

Get omnichannel analytics overview

/api/v1/livechat/analytics/agent-overview

Get Agent Analytics Overview

Livechat Business Hours

UrlShort DescriptionDetails Page

api/v1/livechat/business-hour

Fetches the default business hours of a workspace

api/v1/livechat/business-hours

Retrieves all the business hours attached to a workspace

api/v1/livechat/business-hours.list

Retrieves a list of existing business hours

Livechat Dashboards

UrlShort DescriptionDetails Page

api/v1/livechat/analytics/dashboards/conversation-totalizers

Retrieves conversation totalizers for a department

api/v1/livechat/analytics/dashboards/agents-productivity-totalizers

Retrieves agent productivity totalizer for a department

api/v1/livechat/analytics/dashboards/chats-totalizers

Retrieves chat totalizers for a department

api/v1/livechat/analytics/dashboards/productivity-totalizers

Retrieves productivity totalizers for a department

api/v1/livechat/analytics/dashboards/charts/chats

Retrieves chats chart for a department

api/v1/livechat/analytics/dashboards/charts/chats-per-agent

Retrieves chats per agent for a department chart

api/v1/livechat/analytics/dashboards/charts/agents-status

Retrieves agent's statuses chart

api/v1/livechat/analytics/dashboards/charts/chats-per-department

Retrieves chats per department chart

api/v1/livechat/analytics/dashboards/charts/timings

Retrieves timing charts

Livechat Departments

UrlShort DescriptionDetails Page

api/v1/livechat/department

Retrieves a list of departments

api/v1/livechat/department

Registers a new department

api/v1/livechat/department/:_id

Retrieves a department's info

api/v1/livechat/department/:_id

Updates a department

api/v1/livechat/department/:_id

Removes a department

api/v1/livechat/department.autocomplete

Autocompletes department name

api/v1/livechat/department/:departmentId/agents

Retrieves agents of a specific department

api/v1/livechat/department/:departmentId/agents

Updates agents of a department

api/v1/livechat/department.listByIds

Retrieves a list of departments by an array of department ids

api/v1/livechat/departments.available-by-unit/:unitId

Retrieves departments available by unit Id

api/v1/livechat/analytics/departments/amount-of-chats

Retrieves the number of incoming chats

api/v1/livechat/analytics/departments/average-service-time

Retrieves average service time

api/v1/livechat/analytics/departments/average-chat-duration-time

Retrieves average chats duration

api/v1/livechat/analytics/departments/total-service-time

Retrieves total service time

api/v1/livechat/analytics/departments/average-waiting-time

Retrieves avg waiting time

api/v1/livechat/analytics/departments/total-transferred-chats

Retrieves total transferred chats

api/v1/livechat/analytics/departments/total-abandoned-chats

Retrieves abandoned chats

api/v1/livechat/analytics/departments/percentage-abandoned-chats

Retrieves percentage of abandoned chats

Livechat Inquiries

UrlShort DescriptionDetails Page

api/v1/livechat/inquiries.list

Lists all of the open livechat inquiries

api/v1/livechat/inquiries.take

Takes an open inquiry

api/v1/livechat/inquiries.queued

Lists queued inquiries

api/v1/livechat/inquiries.getOne

Gets one inquiry by room id

api/v1/livechat/inquiry.setSLA

Set SLA to an inquiry.

Livechat Integrations

UrlShort DescriptionDetails Page

api/v1/livechat/integrations.settings

Retrieves a list of integration settings

Livechat Queue

UrlShort DescriptionDetails Page

api/v1/livechat/queue

Retrieves the queued chats

Livechat Rooms

UrlShort DescriptionDetails Page

api/v1/livechat/rooms

Retrieves a list of livechat rooms

api/v1/livechat/room/:rid/priority

Set the priority of a Livechat room.

api/v1/livechat/room/:rid/priority

Remove the priority set to a Livechat room.

api/v1/livechat/room.onHold

Puts an active livechat conversation on hold

Livechat SMS

UrlShort DescriptionDetails Page

api/v1/livechat/sms-incoming/:service

Receives SMS

Livechat Triggers

UrlShort DescriptionDetails Page

api/v1/livechat/triggers

Lists all Livechat triggers

api/v1/livechat/triggers/:_id

Retrieves a Livechat Trigger by id

Livechat Upload

UrlShort DescriptionDetails Page

api/v1/livechat/upload/:rid

Uploads files on livechat room.

Livechat Users

UrlShort DescriptionDetails Page

api/v1/livechat/users/:type

Gets a list of agents or managers

api/v1/livechat/users/:type

Registers a new agent or manager

api/v1/livechat/users/:type/:_id

Gets info about an agent or manager

api/v1/livechat/users/:type/:_id

Removes an agent or manager

Livechat Visitors

UrlShort DescriptionDetails Page

api/v1/livechat/visitors.info

Retrieves visitor info by ID

api/v1/livechat/visitors.pagesVisited/:roomId

Retrieves pages visited by livechat visitor

api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId

Retrieves livechat visitor's chat history

api/v1/livechat/visitors.searchChats/room/:roomId/visitor/:visitorId

Searches a visitor's chat

api/v1/livechat/visitors.autocomplete

Autocompletes visitor's name

api/v1/livechat/visitors.search

Searches the visitor by the term

Livechat Monitors

UrlShort DescriptionDetails Page

api/v1/livechat/monitors

List all monitors

api/v1/livechat/monitors/:username

Get a Monitor

Livechat Priorities

UrlShort DescriptionDetails Page

api/v1/livechat/priorities

Get priorities

api/v1/livechat/priorities/:priorityId

Get a priority

api/v1/livechat/priorities/:priorityId

Update the priority

api/v1/livechat/priorities.reset

Reset the priority

Livechat Tags

UrlShort DescriptionDetails Page

api/v1/livechat/tags

Retrieves a list of tags

livechat/tags/:tagId

Get a tag.

Livechat Units

UrlShort DescriptionDetails Page

api/v1/livechat/units

Create unit

api/v1/livechat/units

List all omnichannel units.

api/v1/livechat/units/:unitId

Retrieves details of a unit

api/v1/livechat/units/:unitId/monitors

List unit monitors

api/v1/livechat/units/:id

Update Unit by Id

api/v1/livechat/units/:id

Delete unit using ID

Voice Channel

URLDescriptionDetails Page

/v1/connector.extension.getRegistrationInfoByUserId

Get registration information by ID

/api/v1/voip/queues.getSummary

Get VoIP query summary data

/api/v1/voip/queues.getSummary

Get VoIP query summary data

/api/v1/voip/queues.getSummary

Get VoIP queue membership data

/v1/voip/queues.getMembershipSubscription

Get VoIP queue membership subscription data

/v1/voip/queues.getMembershipSubscription

Get VoIP queue membership subscription data

v1/voip/queues.getMembershipSubscription

Get the VoIP queue membership subscription data

api/v1/livechat/visitor

Create a VoIP visitor

/api/v1/voip/events

Send VoIP events

/api/v1/omnichannel/extension

Retrieve VoIP extension information

/api/v1/omnichannel/extensions?count=10&offset=10

Retrieve VoIP extensions

/v1/omnichannel/agent/extension

Create, update and delete VoIP extension

/api/v1/voip/managementServer/checkConnection?host&port&username&password

Check management server connection status

/api/v1/voip/callServer/checkConnection?websocketUrl=wss://omni-asterisk.dev.rocket.chat/ws

Check call server connection status

/api/v1/voip/room?token=867ad6a09fc4af29f6f1f2a9cf1deaba&agentId=6vHSSqdBHdm2R4gfi

Create VoIP room

/api/v1/voip/events

Retrieve VoIP room information by ID

/api/v1/voip/room.clos

Close the VoIP conversation

Canned Response

URLShort DescriptionDetails Page

/api/v1/canned-responses

Create a canned response.

/api/v1/canned-responses

Update a canned response.

/api/v1/canned-responses/:_id

Get a canned response

/api/v1/canned-responses

List all canned responses

/api/v1/canned-responses.get

Get user canned responses

/api/v1/canned-responses

Remove a canned response

Integrations

Integration

UrlShort DescriptionDetails Page

/api/v1/integrations.create

Creates an integration.

/api/v1/integrations.get

Gets an integration.

/api/v1/integrations.history

Lists all history of the specified integration.

/api/v1/integrations.list

Lists all of the integrations.

/api/v1/integrations.remove

Removes an integration.

/api/v1/integrations.update

Updates an integration.

Webdav

URLShort DescriptionDetails Page

/api/v1/webdav.getMyAccounts

Retrieves the user's webdav accounts

OAuth App

UrlShort DescriptionDetails Page

/api/v1/oauth-apps.get

Retrieves an OAuth App by id or client id.

/api/v1/oauth-apps.list

Retrieves a list of OAuth Apps.

Notifications

Banners

URLShort DescriptionDetails Page

/api/v1/banners/:id

Gets the banners to be shown to the authenticated user

/api/v1/banners

Gets the banners to be shown to the authenticated user

/api/v1/banners.dismiss

Dismisses a banner

Push

UrlShort DescriptionDetails Page

/api/v1/push.token

Saves push token.

/api/v1/push.token

Removes push token.

/api/v1/push.get

Get push notification for a message

Content Management

Assets

URLShort DescriptionDetails Page

/api/v1/assets.setAsset

Sets an asset image by name.

/api/v1/assets.unsetAsset

Unsets an asset by name.

Custom Emoji

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

Custom Sounds

URLShort DescriptionDetails Page

/api/v1/custom-sounds.list

Retrieves a list of custom sounds.

Custom User Status

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

Statistics

Stats

URLShort DescriptionDetails Page

/api/v1/statistics

Retrieves statistics

/api/v1/statistics.list

Retrieves statistics list

Engagement Dashboard

Users Engagement Dashboard Endpoints

UrlShort DescriptionDetails Page

/api/v1/engagement-dashboard/users/new-users

List new users during a specific period

/api/v1/engagement-dashboard/users/active-users

List active users in the workspace

/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

/api/v1/engagement-dashboard/users/chat-busier/hourly-data

Get hourly data when chat is busier

/api/v1/engagement-dashboard/users/chat-busier/weekly-data

Get weekly data when chat is busier

Messages Engagement Dashboard Endpoints

URLShort DescriptionDetails Page

/api/v1/engagement-dashboard/messages/messages-sent

Get number of daily messages sent during a period

/api/v1/engagement-dashboard/messages/origin

Get origin of messages sent during a period

/api/v1/engagement-dashboard/messages/top-five-popular-channels

Get top 5 popular channels by message count

Channels Engagement Dashboard Endpoints

URLShort DescriptionDetails Page

api/v1/engagement-dashboard/channels/list

Get all channels and the number of messages in each

Subscription

UrlShort DescriptionDetails Page

/api/v1/subscriptions.get

Retrieves all subscriptions.

/api/v1/subscriptions.getOne

Retrieves the subscription by room Id.

/api/v1/subscriptions.read

Marks a room as read.

/api/v1/subscriptions.unread

Marks messages as unread.

Settings

Settings

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

UrlShort DescriptionDetails Page

/api/v1/settings

Lists all private settings.

/api/v1/settings.public

Lists all public settings.

/api/v1/settings.oauth

Returns list of all available oauth services.

/api/v1/service.configurations

Lists all service configurations.

/api/v1/settings/:_id

Retrieves a setting.

/api/v1/settings/:_id

Updates a setting.

Cloud

URLShort DescriptionDetails Page

/api/v1/cloud.manualRegister

Manually registers a workspace

DNS

URLShort DescriptionDetails Page

/api/v1/dns.resolve.srv

Resolves DNS srv records (SRV records) for a hostname

/api/v1/dns.resolve.txt

Resolves DNS text records (TXT records) for a hostname

E2E

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

Imports

URLShort DescriptionDetails Page

/api/v1/uploadImportFile

Upload import file.

/api/v1/downloadPublicImportFile

Download public import file.

/api/v1/startImport

Start import.

/api/v1/getImportFileData

Get file data of an upload.

/api/v1/getImportProgress

Get the progress of an import.

/api/v1/getLatestImportOperations

Get latest import operations

/api/v1/downloadPendingFiles

Download pending files

/api/v1/downloadPendingAvata

Download pending avatars

/api/v1/getCurrentImportOperation

Gets current import operations

Bulk User Import

UrlShort DescriptionDetails Page

/api/v1/import.addUsers

Adds user data to the import staging area.

/api/v1/import.clear

Abort any import operation currently in progress

/api/v1/import.run

Process the data from the current import operation and create the users on Rocket.Chat

/api/v1/import.new

Creates a new import operation.

/api/v1/import.status

Get the status of the current import operation

Instances

URLShort DescriptionDetails Page

/api/v1/instances.get

Retrieves instances

Federation

UrlShort DescriptionDetails Page

api/v1/federation/addServerByUser

Adds a server to search public rooms later

api/v1/federation/listServersByUser

Retrieves all the server names saved by the user

api/v1/federation/removeServerByUser

Remove a server name

api/v1/federation/searchPublicRooms

Returns all the public room given a server name

api/v1/joinExternalPublicRoom

Joins an External public Matrix room

Device Management

URLShort DescriptionDetails Page

/api/v1/sessions/list

Retrieves all sessions of the authenticated user

/api/v1/sessions/list.all

Retrieve the sessions of all users on the workspace

/api/v1/sessions/info

Get user's session

/api/v1/sessions/logout.me

Logout the authenticated user from the current session

/api/v1/sessions/logout

Logout of a session

Auto Translate

URLShort DescriptionDetails Page

/api/v1/autotranslate.getSupportedLanguages

Gets the supported languages by auto-translate.

/api/v1/autotranslate.saveSettings

Saves some settings about auto-translate.

/api/v1/autotranslate.translateMessage

Translates the message.

Commands

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

Email Inbox

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

Invite

UrlShort DescriptionDetails Page

/api/v1/findOrCreateInvite

Created a new Invite or returns an existing one with the same parameters.

/api/v1/listInvites

Lists all of the invite tokens.

/api/v1/removeInvite/:_id

Deletes an invite from the server.

/api/v1/useInviteToken

Reports to the server that an invite token was used.

/api/v1/validateInviteToken

Checks if an invite token is valid.

Licenses

UrlShort DescriptionDetails Page

/api/v1/licenses.get

Gets all registered licenses.

/api/v1/licenses.isEnterprise

Confirm if workspace has enterprise license.

licenses.maxActiveUsers

Get maximum active users.

Video conference

URLShort DescriptionDetails Page

/api/v1/video-conference/jitsi.update-timeout

Updates the timeout of Jitsi video conference in a channel.

Others

URLShort DescriptionDetails Page

/api/apps

Install a private app via URL

/api/v1/shield.svg

Get the the shield svg(badge)

/api/v1/spotlight

Searches for users or rooms that are visible to the user

/api/v1/stdout.queue

Retrieves last 1000 lines of server logs

WhatsApp

DescriptionDetails Page

WhatsApp Business API integration for Rocket.Chat

Send a template message.

Mailer

URLShort DescriptionDetails Page

/api/v1/mailer

Send an email to users on your workspace.

/api/v1/mailer.subscribe

Unsubscribe from mailer

Moderation

UrlShort DescriptionDetails Page

/api/v1/moderation.reportsByUsers

Retrieves all the reported messages grouped by users

/api/v1/moderation.user.reportedMessages

Retrieve all reported messages of a user.

/api/v1/moderation.reports

Retrieve all the reports of a single message

/api/v1/moderation.reportInfo

Get more details of a single report.

/api/v1/moderation.dismissReports

Dismiss all the reports of a particular user.

/api/v1/moderation.user.deleteReportedMessages

Delete all the reports of messages that belongs to user.

Last updated

Rocket.Chat versions receive support for six months after release.