List messages

This endpoint is used to retrieve a list of messages that were submitted for moderation. Each message includes its current moderation status based on the rules configured for the app.

GET /moderation/messages

List messages

cURL

curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/moderation/messages \
  --header 'apikey: <api-key>'

200

{
  "data": [
    {
      "id": "1",
      "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
      "sender": "cometchat-uid-2",
      "receiverType": "user",
      "receiver": "cometchat-uid-1",
      "category": "message",
      "type": "text",
      "data": {
        "entities": {
          "receiver": {
            "entity": {
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp",
              "createdAt": 1751644824,
              "lastActiveAt": 1751644824,
              "name": "Andrew Joseph",
              "role": "default",
              "status": "offline",
              "uid": "cometchat-uid-1"
            },
            "entityType": "user"
          },
          "sender": {
            "entity": {
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
              "createdAt": 1751644824,
              "lastActiveAt": 1751644824,
              "name": "George Alan",
              "role": "default",
              "status": "offline",
              "uid": "cometchat-uid-2"
            },
            "entityType": "user"
          }
        },
        "moderation": {
          "status": "approved"
        },
        "text": "Hi new user"
      },
      "sentAt": 1750335220,
      "updatedAt": 1751644906
    }
  ],
  "meta": {
    "current": {
      "limit": 100,
      "count": 1
    },
    "next": {
      "affix": "append",
      "sentAt": 1750335220,
      "id": "1"
    }
  }
}

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Query Parameters

sender · string

Filters messages by the sender’s uid.

receiverUID · string

Filters messages by the receiver's uid.

receiverGUID · string

Filters messages by the receiver's guid in case of group

category · enum<string>

Filters messages by category. Possible values: message and custom.

Available options: message, custom

type · string

Filters messages by type.

moderationStatus · enum<string>

Filters messages by moderation status.

Available options: disapproved, pending

Response

200 - application/json

Get Message(s)

The response is of type object.