Deprecated Parameters

This document outlines the parameters deprecated in Rocket.Chat’s REST API endpoints and Realtime API methods. Some of these parameters have already been removed, while others are scheduled for removal in upcoming releases. To ensure continued functionality, adopt the recommended alternatives specified for each affected parameter.

REST API

The table below shows the deprecated parameters in our REST API endpoints:

API parameter removals: The following parameters have been permanently removed from their respective API endpoints in v8.0.0:

Name	Parameter affected	Description	Deprecated since	Removed in version
engagement-dashboard/channels/list	`hideRoomsWithNoActivity`	The endpoint no longer accepts `hideRoomsWithNoActivity` parameter. By default, inactive rooms will be excluded from the response.	6.11.0	8.0.0
oauth-apps.get	`appId`	This parameter will no longer be accepted (use clientId or _id instead).	6.0.0	8.0.0
roles.getUsersInRole	`role`	The role parameter will still be used, but its value must now always be the role ID. Querying with the role name as value is deprecated.	4.6.0	8.0.0
roles.addUserToRole	`roleName`	This parameter will no longer be accepted. Use `roleId` instead.	4.6.0	8.0.0
roles.removeUserFromRole	`roleName`	This parameter will no longer be accepted. Use `roleId` instead.	4.6.0	8.0.0

Query and fields query parameters

The query and fields parameters have been deprecated since version 5.0.0 across all supported endpoints to prevent malicious queries. They are disabled by default from version 7.0.0 and can only be enabled by setting the ALLOW_UNSAFE_QUERY_AND_FIELDS_API_PARAMS: true environment variable in your deployment configuration.

Enabling these parameters may expose your workspace to security risks, and Rocket.Chat is not responsible for any resulting vulnerabilities. Proceed with caution and ensure proper security measures are in place.

When enabled, a deprecation message is included in the response header as X-Deprecation-Message. These parameters are scheduled for removal in version 9.0.0, after which enabling them will no longer be an option.

The following endpoints are among those affected:

Endpoint	`query` parameter	`fields` parameter
settings.public	✓	✓
statistics.list	✓	✓
custom-sounds.list	✓	✓
emoji-custom.list	✓	x
integrations.history	✓	✓
integrations.list	✓	✓
users.list	✓	✓
users.info	x	✓
chat.getThreadsList	✓	✓
chat.getThreadMessages	✓	✓
im.files	✓	✓
im.list.everyone	✓	✓
im.messages	✓	✓
im.messages.others	✓	✓
email-inbox.list	✓	✓
spotlight	✓	x
omnichannel/agents/available	✓	x
livechat/rooms (GET)	x	✓
canned-responses (GET)	x	✓
voip/rooms	x	✓
channels.anonymousread	✓	✓
channels.files	✓	✓
channels.list.joined	✓	✓
channels.list	✓	✓
channels.messages	✓	x
channels.getIntegrations	✓	✓
rooms.getDiscussions	✓	✓
teams.list	✓	x
groups.online	✓	x
groups.getIntegrations	✓	✓
groups.listAll	✓	✓
groups.messages	✓	✓
groups.files	✓	✓
channels.online	✓	x
directory	✓	✓
rooms.info	x	✓
dm.messages	✓	✓
custom-user-status.list	✓	x