List reactions made by a user | Sample

7 parameters

tokenstringrequired

Authentication token with the `reactions:read` scope.

userstringoptional

The user whose reactions to list. Defaults to the authenticated user when omitted.

fullbooleanoptional

Set to true to always return the complete reaction list.

countintegeroptional

The number of reactions to request per page.

pageintegeroptional

The page number to retrieve.

cursorstringoptional

Pagination cursor from the previous response's `next_cursor` value. Omit it for the first page.

limitintegeroptional

The maximum number of reactions to return. Fewer items may be returned even when more remain.

2 status codes

200Returns an array of reaction items with paging information and response metadata for continuing pagination.

itemsarray<array>required

okbooleanrequired

Allowed:true

pagingobjectoptional

response_metadataarrayoptional

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:user_not_foundnot_authedinvalid_authaccount_inactivno_permissioninvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typemissing_post_typeteam_added_to_org

okbooleanrequired

Allowed:false

Error handling

The token must grant the reactions:read scope, and user must identify an existing user when supplied. Use cursor with the previous response's next_cursor value for subsequent pages; count, page, and limit must contain integer values.

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.reactionsList.list({
  token: "sk_live_4eC39Hq",
  user: "octocat",
  full: "example",
  count: 20,
  page: 1,
});

{
  "items": [
    {
      "channel": "C3UKJTQAC",
      "message": {
        "bot_id": "B4VLRLMKJ",
        "reactions": [
          {
            "count": 1,
            "name": "robot_face",
            "users": [
              "U2U85N1RV"
            ]
          }
        ],
        "subtype": "bot_message",
        "text": "Hello from Python! :tada:",
        "ts": "1507849573.000090",
        "username": "Shipit Notifications"
      },
      "type": "message"
    },
    {
      "comment": {
        "comment": "This is a file comment",
        "created": 1508286096,
        "id": "Fc7LP08P1U",
        "reactions": [
          {
            "count": 1,
            "name": "white_check_mark",
            "users": [
              "U2U85N1RV"
            ]
          }
        ],
        "timestamp": 1508286096,
        "type": "file_comment",
        "user": "U2U85N1RV"
      },
      "file": {
        "channels": [
          "C2U7V2YA2"
        ],
        "comments_count": 1,
        "created": 1507850315,
        "reactions": [
          {
            "count": 1,
            "name": "stuck_out_tongue_winking_eye",
            "users": [
              "U2U85N1RV"
            ]
          }
        ],
        "title": "computer.gif",
        "user": "U2U85N1RV",
        "username": ""
      }
    },
    {
      "file": {
        "channels": [
          "C2U7V2YA2"
        ],
        "comments_count": 1,
        "created": 1507850315,
        "id": "F7H0D7ZA4",
        "name": "computer.gif",
        "reactions": [
          {
            "count": 1,
            "name": "stuck_out_tongue_winking_eye",
            "users": [
              "U2U85N1RV"
            ]
          }
        ],
        "size": 1639034,
        "title": "computer.gif",
        "user": "U2U85N1RV",
        "username": ""
      },
      "type": "file"
    }
  ],
  "ok": true,
  "response_metadata": {
    "next_cursor": "dGVhbTpDMUg5UkVTR0w="
  }
}

Request

Response

Errors