reactions.list
method
We're still building and not all features are available quite yet. Enjoy this peek into the future!
Not ready for the future? Return to the past at api.slack.com.
Usage info
This method returns a list of all items (file, file comment, channel message, group message, or direct message) with reactions made by the user.
The team_id
is only relevant when using an org-level token. This field will be ignored if the API call is sent using a workspace-level token.
Response
Every item in the list has a type
property, while the other properties depend on the type of item. The possible types are:
message
: the item will have amessage
property containing a message object and achannel
property containing the channel ID for the messagefile
: this item will have afile
property containing a file objectfile_comment
: the item will have afile
property containing the file object and acomment
property containing the file comment
The users
array in the reactions
property will always contain the authenticated user, but might not always contain all users that have reacted. The value of count
, however, will always represent the count of all users who made that reaction (i.e. it may be greater than users.length
).
If the user has multiple reactions on a single message, then the relevant message will appear as multiple identical items in the list - one item for each reaction.
Pagination information follows the returned list of items, and contains:
- the
count
of items returned, up to 1000 - the
total
number of items reacted to - the
page
of results returned in this response, up to 100 - the total number of
pages
available