Rocket.Chat
Secure team messaging and omnichannel communication APIs
Actions (94)
User Management · 21
- Add User to RolePOST /api/v1/roles.addUserToRole
Assign a role to a user (and optionally a room role).
documented - Create RolePOST /api/v1/roles.create
Create a new role in the workspace.
documented - Create User TokenPOST /api/v1/users.createToken
Create a temporary authentication token for a user.
documented - Delete Own AccountPOST /api/v1/users.deleteOwnAccount
Delete the authenticated user's own account.
documented - Delete UserPOST /api/v1/users.delete
Permanently delete a user from the workspace.
documented - Get User PreferencesGET /api/v1/users.getPreferences
Get preferences for the authenticated user.
documented - Get Users in RoleGET /api/v1/roles.getUsersInRole
List users belonging to a given role.
documented - List All PermissionsGET /api/v1/permissions.listAll
Return the list of permissions defined in the workspace.
documented - List RolesGET /api/v1/roles.list
Return all roles in the workspace.
documented - List User's TeamsGET /api/v1/users.listTeams
List teams that a user is a member of.
documented - List UsersGET /api/v1/users.list
List workspace users with optional filtering.
documented - List Users PresenceGET /api/v1/users.presence
Return presence information for workspace users.
documented - List Users by StatusGET /api/v1/users.listByStatus
List users filtered by activation/status.
documented - Reset E2E KeyPOST /api/v1/users.resetE2EKey
Reset a user's end-to-end encryption key.
documented - Reset TOTPPOST /api/v1/users.resetTOTP
Reset the Time-based One-Time Password for a user.
documented - Send Confirmation EmailPOST /api/v1/users.sendConfirmationEmail
Send an email verification to a user.
documented - Send Welcome EmailPOST /api/v1/users.sendWelcomeEmail
Send a welcome email to a user.
documented - Sync RolesGET /api/v1/roles.sync
Sync updated roles.
documented - Update PermissionsPOST /api/v1/permissions.update
Update workspace permissions for roles/users.
documented - Update RolePOST /api/v1/roles.update
Update an existing role.
documented - Update UserPOST /api/v1/users.update
Update user information (profile, credentials, etc.).
documented
Notifications · 18
- Create Push TokenPOST /api/v1/push.token
Create a push token.
documented - Create Push TokenPOST /api/v1/push.token
Create a push notification token (GCM/APN).
documented - Dismiss BannerPOST /api/v1/banners.dismiss
Dismiss a banner for the authenticated user.
documented - Get Banner by IDGET /api/v1/banners/{id}
Retrieve a banner by its ID.
documented - Get BannersGET /api/v1/banners
Get banners available to the authenticated user.
documented - Get Email Inbox by IDGET /api/v1/email-inbox/{_id}
Retrieve a specific email inbox by ID.
documented - Get Push InfoGET /api/v1/push.info
Get status/config of push gateway for the workspace.
documented - Get Push InfoGET /api/v1/push.info
Get push gateway status.
documented - Get Push InfoGET /api/v1/push.info
Get status/config of push gateway for the workspace.
documented - Get Push Info (dup)GET /api/v1/push.info
Push gateway information.
documented - List Email InboxesGET /api/v1/email-inbox
List Omnichannel email inboxes.
documented - List Email Inboxes (alt)GET /api/v1/email-inbox.list
Alternative listing endpoint for email inboxes.
documented - Search Email InboxGET /api/v1/email-inbox.search
Search email inbox by criteria.
documented - Send Test EmailGET /api/v1/email-inbox.send-test/{_id}
Send a test email to an Omnichannel inbox.
documented - Set Email InboxPOST /api/v1/email-inbox
Configure an Omnichannel email inbox.
documented - Test Push NotificationsGET /api/v1/push.test
Test push notifications configuration.
documented - Test Push NotificationsGET /api/v1/push.test
Test push notifications.
documented - Test Push NotificationsGET /api/v1/push.test
Test push notifications configuration.
documented
Content Management · 10
- Create Custom EmojiPOST /api/v1/emoji-custom.create
Create a new custom emoji.
documented - Create Custom User StatusPOST /api/v1/custom-user-status.create
Create a custom user status.
documented - Delete Custom EmojiPOST /api/v1/emoji-custom.delete
Delete a custom emoji.
documented - List All Custom EmojisPOST /api/v1/emoji-custom.all
List all custom emojis.
documented - List All Custom Emojis (dup)POST /api/v1/emoji-custom.all
List all custom emojis.
documented - List Custom SoundsGET /api/v1/custom-sounds.list
List custom sounds.
documented - List Custom User StatusGET /api/v1/custom-user-status.list
List custom user statuses.
documented - List Updated Custom EmojisGET /api/v1/emoji-custom.list
List updated custom emojis.
documented - Update Custom EmojiPOST /api/v1/emoji-custom.update
Update a custom emoji.
documented - Update Custom User StatusPOST /api/v1/custom-user-status.update
Update a custom user status.
documented
Omnichannel · 8
- Get Available Agent InformationGET /api/v1/omnichannel/agents/available
Get currently available omnichannel agent information.
documented - Get Available Livechat Agent InformationGET /api/v1/livechat/agents/available
List available livechat agents.
documented - Get Livechat UserGET /api/v1/livechat/users/{type}/{_id}
Get info for a specific livechat user.
documented - Get Next Livechat AgentGET /api/v1/livechat/agent.next/{token}
Get the next available agent for an incoming conversation.
documented - Get Omnichannel ContactGET /api/v1/omnichannel/contact
Retrieve omnichannel contact by token.
documented - List Livechat Agents/ManagersGET /api/v1/livechat/users/{type}
List livechat users of a given type (agent/manager).
documented - Register or Update Omnichannel ContactPOST /api/v1/omnichannel/contact
Register a new omnichannel contact or update an existing one.
documented - Search Omnichannel ContactsGET /api/v1/omnichannel/contact.search
Search omnichannel contacts by name/email/phone.
documented
Rooms · 8
- Add All to ChannelPOST /api/v1/channels.addAll
Add all workspace users to a channel.
documented - Add Channel LeaderPOST /api/v1/channels.addLeader
Assign the leader role to a channel member.
documented - Add Channel ModeratorPOST /api/v1/channels.addModerator
Assign the moderator role to a channel member.
documented - Add Channel OwnerPOST /api/v1/channels.addOwner
Assign the owner role to a channel member.
documented - Archive ChannelPOST /api/v1/channels.archive
Archive a channel.
documented - Create ChannelPOST /api/v1/channels.create
Create a public channel and optionally add initial members.
documented - Get Channel InfoGET /api/v1/channels.info
Retrieve channel details.
documented - Read Channel Messages AnonymouslyGET /api/v1/channels.anonymousread
Fetch public channel messages for anonymous reads when allowed.
documented
Messages · 7
- Delete Chat MessagePOST /api/v1/chat.delete
Delete a chat message.
documented - Follow MessagePOST /api/v1/chat.followMessage
Follow a message for notifications.
documented - Get MessageGET /api/v1/chat.getMessage
Retrieve a single chat message by ID.
documented - List ThreadsGET /api/v1/chat.getThreadsList
List thread conversations in a room.
documented - React to MessagePOST /api/v1/chat.react
Add or remove a reaction to a message.
documented - Unfollow MessagePOST /api/v1/chat.unfollowMessage
Unfollow a message.
documented - Update MessagePOST /api/v1/chat.update
Update a chat message's content.
documented
Integrations · 6
- Create IntegrationPOST /api/v1/integrations.create
Create an incoming or outgoing integration.
documented - Get IntegrationGET /api/v1/integrations.get
Get information about a specific integration.
documented - Get Integration HistoryGET /api/v1/integrations.history
Return integration history based on permissions.
documented - List IntegrationsGET /api/v1/integrations.list
List integrations for the workspace.
documented - List Integrations (alt)GET /api/v1/integrations.list
List integrations (alternate listing path).
documented - Update IntegrationPUT /api/v1/integrations.update
Update an existing integration.
documented
Settings · 6
- Add Custom OAuthPOST /api/v1/settings.addCustomOAuth
Add a custom OAuth integration.
documented - Get Setting by IDGET /api/v1/settings/{_id}
Get a single setting by its _id.
documented - List OAuth SettingsGET /api/v1/settings.oauth
List OAuth service configurations.
documented - List Private SettingsGET /api/v1/settings
List private workspace settings.
documented - List Public SettingsGET /api/v1/settings.public
List public workspace settings.
documented - Update SettingPOST /api/v1/settings/{_id}
Update a single setting by its _id.
documented
Authentication · 4
- LoginPOST /api/v1/login
Authenticate a user with username or email and password; obtain an authToken and basic user data.
documented - Login with FacebookPOST /api/v1/login-facebook
Login using a Facebook OAuth token.
documented - Login with GooglePOST /api/v1/login-google
Login using a Google OAuth token.
documented - Login with TwitterPOST /api/v1/login-twitter
Login using a Twitter OAuth token.
documented