Links

Fetch Reports of a Message

Retrieve all the reports of a single message. A message can have many reports. It supports the Pagination parameters.
It requires the view-moderation-console permission.
URL
Requires Auth
HTTP Method
/api/v1/moderation.reports
yes
GET

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
The authenticated user ID.
X-Auth-Token
myauth-token
Required
Auth token.

Query Parameter

Argument
Example
Required
Description
msgId
EbhcT4vjrCDyZuHKq
Required
The id of the message to fetch reports for.

Example Call

curl --location 'http://localhost:3000/api/v1/moderation.reports?msgId=EbhcT4vjrCDyZuHKq' \
--header 'x-auth-token: aEO8Hw3zorBFQtAEYsNPnr67Li9-lY5kX1foen8UiiS' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ' \
--data ''

Example Result

Success

{
"reports": [
{
"_id": "64ef0f992c26843a68c1f785",
"description": "test report\n",
"reportedBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "funke.olasupo",
"name": "Funke Olasupo",
"createdAt": "2023-02-20T13:42:07.119Z"
},
"room": {
"_id": "5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ",
"t": "d"
},
"ts": "2023-08-30T09:44:57.912Z"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}

Error

Any of the following errors can occur on the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • No Permission: Occurs when the authenticated user doesn't have the view-moderation-console permission.
  • MessageId Required: Occurs when msgId is missing in the request query parameter.
Authorization
No Permission
Required MsgId
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}
{
"success": false,
"error": "must have required property 'msgId' [invalid-params]",
"errorType": "invalid-params"
}

Change Log

Version
Description
6.2.0
Added
Last modified 5mo ago
Rocket.Chat versions receive support for six months after release.