Get reactions for an item | Sample

6 parameters

tokenstringrequired

Authentication token with the `reactions:read` scope.

channelstringoptional

The channel where the message whose reactions you want to retrieve was posted.

filestringoptional

The identifier of the file whose reactions you want to retrieve.

file_commentstringoptional

The identifier of the file comment whose reactions you want to retrieve.

fullbooleanoptional

Set to true to always return the complete reaction list.

timestampstringoptional

The timestamp of the message whose reactions you want to retrieve.

2 status codes

200Returns the requested item and its reactions, identifying whether the item is a message, file, or file comment.

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:bad_timestampfile_not_foundfile_comment_not_foundmessage_not_foundno_item_specifiednot_authedinvalid_authaccount_inactiveno_permissioninvalid_array_arginvalid_charsetinvalid_form_data

okbooleanrequired

Allowed:false

Error handling

The token must grant the reactions:read scope. Identify the target with channel and timestamp, file, or file_comment; set full to true when you need the complete reaction list.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.reactionsGet.list({
  token: "sk_live_4eC39Hq",
  channel: "example",
  file: "example",
  fileComment: "example",
  full: "example",
});

{
  "file": {
    "channels": [
      "C2U7V2YA2"
    ],
    "comments_count": 1,
    "created": 1507850315,
    "groups": [],
    "id": "F7H0D7ZA4",
    "ims": [],
    "name": "computer.gif",
    "reactions": [
      {
        "count": 1,
        "name": "stuck_out_tongue_winking_eye",
        "users": [
          "U2U85N1RV"
        ]
      }
    ],
    "timestamp": 1507850315,
    "title": "computer.gif",
    "user": "U2U85N1RV"
  },
  "ok": true,
  "type": "file"
}

Request

Response

Errors