reactions.get

Gets reactions for an item.

Facts

Method URL: https://slack.com/api/reactions.get

Preferred HTTP method: GET

Accepted content types: application/x-www-form-urlencoded

Rate limiting: Tier 3

Works with:

Token type	Required scope(s)
bot	`reactions:read`
user	`reactions:read`
classic bot	`bot`

This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).

Arguments

tokenRequired

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Examplexxxx-xxxxxxxxx-xxxx

channelOptional

Channel where the message to get reactions for was posted.

ExampleC1234567890

fileOptional

File to get reactions for.

ExampleF1234567890

file_commentOptional

File comment to get reactions for.

ExampleFc1234567890

fullOptional

If true always return the complete reaction list.

Exampletrue

timestampOptional

Timestamp of the message to get reactions for.

Example1234567890.123456

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Response

The response contains the item with reactions.

Common successful response

Typical success response

{
    "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"
}

Common error response

Typical error response

{
    "ok": false,
    "error": "invalid_auth"
}

Different item types can be reacted to. The item returned has a type property, the other properties depend on the type of item. The possible types are:

message: the item will have a message property containing a message object and a channel property containing the channel ID for the message.
file: this item will have a file property containing a file object.
file_comment: the item will have a file property containing the file object and a comment property containing the file comment.

The users array in the reactions property might not always contain all users that have reacted (we limit it to X users, and X might change), however count will always represent the count of all users who made that reaction (i.e. it may be greater than users.length). If the authenticated user has a given reaction then they are guaranteed to appear in the users array, regardless of whether count is greater than users.length or not. If the complete list of users is required they can still be obtained by specifying the full argument.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`file_comment_not_found`	File comment specified by `file_comment` does not exist.
`message_not_found`	Message specified by `channel` and `timestamp` does not exist.
`bad_timestamp`	Value passed for `timestamp` was invalid.
`no_item_specified`	`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.
`file_not_found`	File specified by `file` does not exist.
`not_authed`	No authentication token provided.
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`account_inactive`	Authentication token is for a deleted user or workspace.
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed.
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`method_deprecated`	The method has been deprecated.
`deprecated_endpoint`	The endpoint has been deprecated.
`two_factor_setup_required`	Two factor setup is required.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`accesslimited`	Access to this method is limited on the current network
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

Was this page helpful?