GET
/
api
/
v2
/
reactions
get list of reactions.
curl --request GET \
  --url https://apix.us.amity.co/api/v2/reactions \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "data": {
    "reactions": [
      {
        "referenceId": "<string>",
        "referenceType": "<string>",
        "reactors": [
          {
            "reactionName": "<string>",
            "userId": "<string>",
            "userPublicIdId": "<string>",
            "userInternalId": "<string>",
            "reactionId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "users": [
      {
        "_id": "<string>",
        "path": "<string>",
        "userId": "<string>",
        "userInternalId": "<string>",
        "userPublicId": "<string>",
        "roles": [
          "<string>"
        ],
        "permissions": [
          "MUTE_CHANNEL"
        ],
        "displayName": "<string>",
        "profileHandle": "<string>",
        "description": "<string>",
        "avatarFileId": "<string>",
        "avatarCustomUrl": "<string>",
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "metadata": {},
        "isGlobalBan": true,
        "isBrand": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isDeleted": true
      }
    ],
    "files": [
      {
        "fileId": "<string>",
        "fileUrl": "<string>",
        "type": "image",
        "accessType": "public",
        "altText": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "attributes": {
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mimeType": "<string>",
          "metadata": {
            "exif": {},
            "gps": {},
            "height": 123,
            "width": 123,
            "isFull": true
          }
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

referenceId
string
required

Reference id

Maximum length: 900
referenceType
enum<string>
required

Reference type

Available options:
message,
post,
comment,
story
reactionName
string

Reaction name

Maximum length: 100
options
object

Response

200
application/json

Reaction information.

The response is of type object.