Rocket Chat Features

 Sign Up with social account like linked-in, Facebook, Gmail etc.

 Login with username and password.
 One to One Chat
 Perform Add reaction, reply, Quote, Copy, Report Message, Star, Edit, Delete message
action over message, Block User
 Upload Photo from Library
 Send Emojis
 Create Channel by Channel name
 View description & topics of channel
 View files shared in a channel
 View member list of channel
 View Starred of channel
 View @Mentions
 View Pinned of channel
 Set Notification preferences of channel
 Change Status to Online, Away, busy, Invisible.
 View and Edit Profile our Profile
 View Other user profile
 Search user by their name
 Change Password
 Sort Chats using Alphabetically & Activity
 Group by Unread, Favourites, type.
 Notification for the chat.
 Search Messages in channel and One to one chat.
 Rocket Chat – Available APIs List

Url Short Description Details Page

/api/v1/info Information about the Rocket.Chat server. Link
/api/v1/directory Search by users or channels on all server. Link
/api/v1/shield.svg Gets the shield svg(badge) to add in your website. Link
/api/v1/spotlight Searches for users or rooms that are visible to the
Link
user.
/api/v1/statistics Statistics about the Rocket.Chat server. Link
/
api/v1/statistics.list Selectable statistics about the Rocket.Chat server. Link

Assets
Url Short Description Details Page
/api/v1/assets.setAsset Set an asset image by name. Link
/api/v1/assets.unsetAsset Unset an asset by name Link

Authentication
Url Short Description Details Page
/api/v1/login Authenticate with the REST API. Link
/api/v1/login Authenticate with google. Link
/api/v1/login Authenticate with facebook. 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

Users
Details
Url Short Description
Page
/api/v1/users.create Create a new user. Link
/api/v1/users.createToken Create a user authentication
Link
token.
/api/v1/users.delete Deletes an existing user. Link
/api/v1/users.deleteOwnAccount Deletes your own user. Link
/api/v1/users.forgotPassword Send email to reset your
Link
password.
/
api/v1/users.generatePersonalAccessTok Generate Personal Access Link
en Token.

/api/v1/users.getAvatar Gets the URL for a user’s

Link
avatar.
/api/v1/users.getPersonalAccessTokens Gets the user’s personal access Link
 Details
Url Short Description
Page
tokens.
/api/v1/users.getPreferences Gets all preferences of user. Link
/api/v1/users.getPresence Gets the online presence of a
Link
user.
/api/v1/users.getUsernameSuggestion Gets a suggestion a new
Link
username to user.
Gets a user’s information,
/api/v1/users.info limited to the caller’s Link
permissions.
All of the users and their
/api/v1/users.list information, limited to Link
permissions.
/
api/v1/users.regeneratePersonalAccessT Regenerate a user personal
Link
oken access token.
/api/v1/users.register Register a new user. Link
/ Remove a personal access
api/v1/users.removePersonalAccessToken Link
token.
/api/v1/users.resetAvatar Reset a user’s avatar Link
/api/v1/users.setAvatar Set a user’s avatar Link
/api/v1/users.setPreferences Set user’s preferences Link
/api/v1/users.update Update an existing user. Link
/api/v1/users.updateOwnBasicInfo Update basic information of
Link
own user.

Channels
Details
Url Short Description
Page
/api/v1/channels.addAll Adds all of the users on the
Link
server to a channel.
/api/v1/channels.archive Archives a channel. Link
/api/v1/channels.cleanHistory Cleans up a channel’s history,
Link
requires special permission.
/api/v1/channels.close Removes a channel from a
Link
user’s list of channels.
/api/v1/channels.counters Gets channel counters. Link
/api/v1/channels.create Creates a new channel. Link
/api/v1/channels.delete Removes a channel. Link
/api/v1/channels.files Gets a list of files from a
Link
channel.
/
api/v1/channels.getAllUserMentionsByCha Gets all the mentions of a Link
nnel channel.

/api/v1/channels.getIntegrations Gets the channel’s

Link
integration.
 Details
Url Short Description
Page
/api/v1/channels.history Retrieves the messages from
Link
a channel.
/api/v1/channels.info Gets a channel’s information. Link
/api/v1/channels.invite Adds a user to a channel. Link
/api/v1/channels.kick Removes a user from a
Link
channel.
/api/v1/channels.leave Removes the calling user
Link
from a channel.
/api/v1/channels.list Retrieves all of the channels
Link
from the server.
/api/v1/channels.list.joined Gets only the channels the
Link
calling user has joined.
/api/v1/channels.members Retrieves all channel users. Link
/api/v1/channels.messages Retrieves all channel
Link
messages.
/api/v1/channels.moderators List all moderators of a
Link
channel.
/api/v1/channels.open Adds the channel back to the
Link
user’s list of channels.
/api/v1/channels.rename Changes a channel’s name. Link
/api/v1/channels.roles Gets the user’s roles in the
Link
channel.
/api/v1/channels.setCustomFields Sets a channel’s custom
Link
fields.
/api/v1/channels.setAnnouncement Sets a channel’s
Link
announcement.
/api/v1/channels.setDefault Sets whether a channel is a
Link
default channel or not.
/api/v1/channels.setDescription Sets a channel’s description. Link
/api/v1/channels.setJoinCode Sets the channel’s code
Link
required to join it.
/api/v1/channels.setPurpose Sets a channel’s description. Link
/api/v1/channels.setReadOnly Sets whether a channel is
Link
read only or not.
/api/v1/channels.setTopic Sets a channel’s topic. Link
/api/v1/channels.setType Sets the type of room the
Link
channel should be.
/api/v1/channels.unarchive Unarchives a channel. Link

Groups
Details
Url Short Description
Page
/api/v1/groups.archive Archives a private group. Link
/api/v1/groups.close Removes a private group from the list of Link
 Details
Url Short Description
Page
groups.
/api/v1/groups.counters Gets 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 Gets a list of files from a private group. Link
/api/v1/groups.history Retrieves the messages from a private
Link
group.
/api/v1/groups.info Gets the information about a private
Link
group.
/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 calling user from the private
Link
group.
/api/v1/groups.list List the private groups the caller is part
Link
of.
/api/v1/groups.listAll List all the private groups. Link
/api/v1/groups.members Gets the users of participants of a private
Link
group.
/api/v1/groups.messages Retrieves all group messages. Link
/api/v1/groups.moderators List all moderators of a group. Link
/api/v1/groups.open Adds the private group back to the list of
Link
groups.
/api/v1/groups.rename Changes the name of the private group. Link
/api/v1/groups.roles Gets the user’s roles in the private group. Link
/
api/v1/groups.setAnnouncemen Sets a group’s announcement. Link
t
/
api/v1/groups.setCustomField Sets private group’s custom fields. Link
s
/
api/v1/groups.setDescription Sets a private group’s description. Link
/api/v1/groups.setPurpose Sets a private group’s description. 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

Chat
Details
Url Short Description
Page
/api/v1/chat.delete Deletes an existing chat message. Link
/api/v1/chat.getMessage Retrieves a single chat message. Link
/api/v1/chat.pinMessage Pins a chat message to the message’s Link
 Details
Url Short Description
Page
channel.
/api/v1/chat.postMessage Posts a new chat message. Link
/api/v1/chat.react Sets/unsets the user’s reaction to an
Link
existing chat message.
/api/v1/chat.reportMessage Reports a message. Link
/api/v1/chat.search Search for messages in a channel. Link
/api/v1/chat.starMessage Stars a chat message for the
Link
authenticated user.
/api/v1/chat.sendMessage Send new chat message. Link
/api/v1/chat.unPinMessage Removes the pinned status of the
Link
provided chat message.
/api/v1/chat.unStarMessage Removes the star on the chat message
Link
for the authenticated user.
/api/v1/chat.update Updates the text of the chat message. Link
/
api/v1/chat.getMessageReadRecei Retrieves message read receipts. Link
pts

IM
Details
Url Short Description
Page
/api/v1/im.close Removes a direct message from the list of direct
Link
messages.
/api/v1/im.counters Gets counters of direct messages. Link
/api/v1/im.create Create a direct message session with another
Link
user.
/api/v1/im.history Retrieves the 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 the users of participants of a direct
Link
message.
/api/v1/im.messages Retrieves the messages from specific direct
Link
message.
/
api/v1/im.messages.other Retrieves the messages from any direct message
Link
s in the server.
/api/v1/im.list List the direct messages the caller is part of. Link
/api/v1/im.list.everyone List all direct message the caller in the server. Link
/api/v1/im.open Adds the direct message back to the list of direct
Link
messages.
/api/v1/im.setTopic Sets a direct message topic. Link

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

Permissions
Url Short Description Details Page
/api/v1/permissions.list 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.create Create a new role in the system. Link
/api/v1/roles.list Gets all the roles in the system. Link
/api/v1/roles.addUserToRole Assign a role to an user. Link

Push Token
Url Method Short Description Details Page
/api/v1/push.token POST Saves push token. Link
/api/v1/push.token DELETE Removes push token. Link

Rooms
Details
Url Short Description
Page
/api/v1/rooms.cleanHistory Cleans up a room’s history, requires special
Link
permission.
/api/v1/rooms.favorite Favorite/Unfavorite room. Link
/api/v1/rooms.get Gets rooms. Link
/api/v1/rooms.info Gets info from a room. Link
/api/v1/rooms.leave Leaves a room. Link
/
api/v1/rooms.saveNotificatio Sets the notifications settings of specific Link
n channel.
/api/v1/rooms.upload/:rid Upload a message with attached file. Link

Command Methods
Url Short Description Details Page
/api/v1/commands.get Get specification of the slash command. Link
/api/v1/commands.list Lists all available slash commands. Link
/api/v1/commands.run Execute a slash command in the specified room. Link
Emoji Custom
Url Short Description Details Page
/api/v1/emoji-custom List the custom emojis available. Link

Settings
Details
Url Method Short Description
Page
/api/v1/settings GET Lists all private settings. Link
/api/v1/settings.public GET Lists all public settings. Link
/api/v1/settings.oauth GET Return list of all available oauth
Link
services.
/
api/v1/service.configuration GET Lists all service configurations. Link
s
/api/v1/settings/:_id GET Gets a setting. Link
/api/v1/settings/:_id POST Updates a setting. Link

Subscriptions
Url Method Short Description Details Page
/api/v1/subscriptions.get GET Get all subscriptions. Link
/api/v1/subscriptions.getOne GET Get the subscription by room Id. Link
/api/v1/subscriptions.read POST Mark a room as read. Link
/api/v1/subscriptions.unread POST Mark messages as unread. Link