List a user's saved items, formerly known as _stars_.
GEThttps://slack.com/api/stars.list
application/x-www-form-urlencoded
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
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=
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.
0
20
This method lists the items starred by the authed user.
The response contains a list of starred items followed by pagination information.
{
"ok": true,
"items": [
{
"type": "message",
"channel": "C2147483705",
"message": {...}
},
{
"type": "file",
"file": { ... }
}
{
"type": "file_comment",
"file": { ... },
"comment": { ... }
}
{
"type": "channel",
"channel": "C2147483705"
},
],
"response_metadata": {
"next_cursor": "dGVhbTpDMUg5UkVTR0w="
}
}
Different item types can be starred. Every item in the list has a type
property, the
other property depend on the type of item. The possible types are:
message
: the item will have a message
property containing a message objectfile
: 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.channel
: the item will have a channel
property containing the channel ID.im
: the item will have a channel
property containing the channel ID for this direct message.group
: the item will have a group
property containing the channel ID for the private group.This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a limit
value under 1000
. We recommend no more than 200
results at a time.
Responses will include a top-level response_metadata
attribute containing a next_cursor
value. By using this value as a cursor
parameter in a subsequent request, along with limit
, you may navigate through the collection page by virtual page.
See pagination for more information.
Typical success response
{
"ok": true
}
Typical error response
{
"ok": false,
"error": "invalid_auth"
}
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 |
---|---|
missing_argument | A required argument is missing. |
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. |
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
token_expired | Authentication token has expired |
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. |
is_bot | This method cannot be called by a bot user. |
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. |
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 |