reactions.list
Lists reactions made by a user.
Facts
Method URL: | https://slack.com/api/reactions.list | ||||||||
---|---|---|---|---|---|---|---|---|---|
Preferred HTTP method: | GET | ||||||||
Accepted content types: | application/x-www-form-urlencoded | ||||||||
Rate limiting: | Tier 2 | ||||||||
Works with: |
|
This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
count
Number of items to return per page.
Default: 100
20
cursor
Parameter for pagination. Set cursor
equal to the next_cursor
attribute returned by the previous request's response_metadata
. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
dXNlcjpVMDYxTkZUVDI=
full
If true always return the complete reaction list.
Exampletrue
limit
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
Default: 0
20
page
Page number of results to return.
Default: 1
2
team_id
encoded team id to list reactions in, required if org token is used
ExampleT1234567890
user
Show reactions made by this user. Defaults to the authed user.
ExampleW1234567890
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
Response
The response contains a list of items with reactions followed by pagination information.
Common successful response
Typical success response
{
"items": [
{
"type": "message",
"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"
}
},
{
"comment": {
"type": "file_comment",
"comment": "This is a file comment",
"created": 1508286096,
"id": "Fc7LP08P1U",
"reactions": [
{
"count": 1,
"name": "white_check_mark",
"users": [
"U2U85N1RV"
]
}
],
"timestamp": 1508286096,
"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="
}
}
Common error response
Typical error response
{
"ok": false,
"error": "invalid_auth"
}
Different item types can be reacted to. Every item in the list has a type
property, 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 message.file
: this item will have afile
property containing a file object.file_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 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.
The paging information contains the count
of items returned, the total
number of items reacted to, the page
of results returned in this response and
the total number of pages
available. Please note that the max count
value is 1000
and the max page
value is 100
.
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 |
---|---|
user_not_found | Value passed for |
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. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
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 |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
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 |
superfluous_charset | The method was called via a |