slackLists.items.list method
Facts
- HTTP
- JavaScript
- Python
- Java
POST https://slack.com/api/slackLists.items.list
app.client.slackLists.items.list
app.client.slackLists_items_list
app.client().slackListsItemsList
application/x-www-form-urlencoded Arguments
Required arguments
tokenstringRequiredToken with which to authenticate the session.
list_idstringRequiredID of the List.
F12345678Optional arguments
limitintegerOptionalThe maximum number of records to return.
100cursorstringOptionalNext cursor for pagination.
bGlzdF9pZDoxMjIxNzk3NzMyNDgzO2lkOjEyNzAxMjMxNTEzOTQ7ZGF0ZV9jcmVhdGVkOjE3NTE1NTkyMTU=archivedbooleanOptionalBoolean indicating whether archived items or normal items should be returned.
trueUsage info
This method is used to retrieve many items from one List. The example successful JSON response below shows the information that will be returned, with ? denoting whether the field may be present in the response.
Sample requests data
{
"ok": true,
"items": [ // array of rows/items for a given List
{
"id": <string>, // the encoded ID of the item
"list_id": <string>, // the encoded List ID of the item
"date_created": <integer>, // the date the item was created
"fields": [ // data for each cell
{
"key": <string>, // an identifier for the column. It can either be an encoded column ID or any text. This will be deprecated in favor of `column_id`
"value": <boolean | string | number | null>, // the value of the cell. This will also be deprecated eventually in favor of typed values defined in their own field below
?"column_id": <string>,
?"text": <string>, // plain text fallback of the cell value, similar to normal Slack messages
?"rich_text": [<rich text>], // Block Kit-formatted message. Only the rich text variant is supported at this time
?"message": [
{
"value": <string>, // the message URL
"channel_id": <string>, // the encoded channel ID
"ts": <string>, // the timestamp the message was sent
"thread_ts": <string> // the timestamp the message in thread was sent
}
],
?"number": [ <number> ], // an array of numbers (integer or rational numbers)
?"select": [ <string> ], // an array of List encoded option IDs
?"date": [ <string> ], // an array of date strings in the format YYYY-MM-DD
?"user": [ <string> ], // an array of encoded user IDs
?"channel": [ <string> ], // an array of encoded channel IDs
?"attachment": [ <string> ], // an array of encoded file IDs
?"checkbox": [ boolean ], // boolean value indicating whether or not the checkbox is enabled
?"email": [ <string> ], // an array of emails
?"phone": [ <string> ], // an array of phone numbers
?"rating": [ <integer> ], // an integer representing the number of emoji for a given rating (the array will have one value)
?"timestamp": [ <integer> ], // an array of unix timestamps
?"link": [
{
"originalUrl": <string>, // the link URL
?"attachment": <object | null>, // metadata information retrieved from the link URL
?"displayAsUrl": <boolean>, // if true, the link URL will be displayed in the cell instead of website name retrieved from URL metadata
?"displayName": <displayName> // the name to display in the cell
}
],
"reference": [ // a field referencing another entity, such as another List or a canvas
{
?"message": { // reference to a message
"channel_id": <string>, // encoded channel ID
"ts": <string>, // timestamp the message was sent
?"thread_ts": <string> // timestamp the thread message was sent
},
?"list_record": { // reference to a List item
"list_id": <string>, // the encoded List ID
"row_id": <string> // the encoded row/item ID
},
?"file": { // reference to a file
"file_id": <string> // the encoded file ID
},
?"canvas_section": { // reference to a canvas section
"file_id": <string>, // the encoded canvas ID
"section_id": <string> // the section ID of the canvas
}
}
]
}
],
?"created_by": <string>, // the encoded user ID of the user who created the item
?"updated_timestamp": <string>, // the date the item was last updated
?"updated_by": <string>, // the encoded user ID of the user who performed the update on the item
?"parent_record_id": <string>, // the encoded item ID of the parent item in case this is a subtask
?"archived": <boolean>, // indicates whether this item is archived or not
?"is_subscribed": <boolean>, // indicates whether the user sending the request is subscribed to the item
?"saved": { // reminder information for item
"is_archived": <boolean>, // indicates whether the reminder is archived or not
?"date_due": <integer>, // the date the reminder is due
?"date_completed": <integer>, // the date the reminder was marked as completed
"state": <string> // The state of the reminder. Values allowed are `archived`, `in_progress` and `completed`
},
?"saved_fields": { // reminder information for specific cells
"Col1234ABCD": { // the encoded column ID for the reminder of the item
"is_archived": <boolean>, // indicates whether the reminder is archived or not
?"date_due": <integer>, // the date the reminder is due
?"date_completed": <integer>, // the date the reminder was marked as completed
"state": <string> // The state of the reminder. Values allowed are `archived`, `in_progress`, and `completed`
}
}
}
],
"response_metadata": { // response metadata with cursor information
"next_cursor": <string> // cursor information for the next set of items
}
}
Response
Typical success response
{
"ok": true,
"items": [
{
"id": "Rec12345678",
"list_id": "F1234ABCD",
"fields": [
{
"key": "title",
"column_id": "Col10000000",
"value": "{\"rich_text\": [ { \"type\": \"rich_text_section\", \"elements\": [ { \"type\": \"text\", \"text\": \"Project Alpha\" }]}]}",
"text": "Project Alpha",
"rich_text": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "Project Alpha"
}
]
}
]
},
{
"key": "due_date",
"column_id": "Col10000001",
"value": "2024-03-20",
"date": [
"2024-03-20"
]
},
{
"key": "Col80000005",
"column_id": "Col10000002",
"value": "Opt123",
"select": [
"Opt123"
]
},
{
"key": "assignee",
"column_id": "Col10000003",
"value": "U1234567",
"user": [
"U1234567"
]
},
{
"key": "completed",
"column_id": "Col10000004",
"value": true,
"checkbox": true
},
{
"key": "contact",
"column_id": "Col10000005",
"value": "john.doe@example.com",
"email": [
"john.doe@example.com"
]
},
{
"key": "phone_number",
"column_id": "Col10000006",
"value": "+1-555-123-4567",
"phone": [
"+1-555-123-4567"
]
},
{
"key": "project_channel",
"column_id": "Col10000007",
"value": "C1234567|C2345678",
"channel": [
"C1234567",
"C2345678"
]
},
{
"key": "satisfaction",
"column_id": "Col10000008",
"value": 4,
"rating": [
4
]
},
{
"key": "last_updated",
"column_id": "Col10000009",
"value": 1710892800,
"timestamp": [
1710892800
]
},
{
"key": "documentation",
"column_id": "Col10000010",
"value": "https://example.com/docs",
"link": [
{
"url": "https://example.com/docs",
"text": "Project Documentation"
}
]
},
{
"key": "related_item",
"column_id": "Col10000011",
"value": "{\"file\":{\"file_id\":\"F1234ABCE\"}}",
"reference": [
{
"file": {
"file_id": "F1234ABCE"
}
}
]
}
],
"saved": {
"is_archived": false,
"state": "in_progress",
"date_due": 1710892800,
"date_completed": 0
},
"saved_fields": {
"Col10000000": {
"is_archived": true,
"state": "archived",
"date_due": 1710892800,
"date_completed": 1710880000
},
"Col10000001": {
"is_archived": false,
"state": "in_progress",
"date_due": 1710895000,
"date_completed": 0
}
}
}
],
"next_cursor": "dGVhbTpDMDExMzIyMzQ1Njc4"
}
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 parameter in the response.
access_deniedAccess to a resource specified in the request is denied.
accesslimitedAccess to this method is limited on the current network
account_inactiveAuthentication token is for a deleted user or workspace when using a bot token.
archive_not_supportedArchiving is not supported.
deprecated_endpointThe endpoint has been deprecated.
ekm_access_deniedAdministrators have suspended the ability to post a message.
enterprise_is_restrictedThe method cannot be called from an Enterprise.
fatal_errorThe 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_errorThe 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.
invalid_arg_nameThe 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_argumentsThe method was called with invalid arguments.
invalid_array_argThe method was passed an array as an argument. Please only input valid strings.
invalid_authSome 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.
invalid_charsetThe 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_cursorValue passed for cursor was not valid or is no longer valid.
invalid_form_dataThe 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_typeThe 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.
list_not_foundThe List was not found.
method_deprecatedThe method has been deprecated.
missing_post_typeThe method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
missing_scopeThe token used is not granted the specific scope permissions required to complete this request.
no_permissionThe 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.
not_allowed_token_typeThe token type used in this request is not allowed.
not_authedNo authentication token provided.
org_login_requiredThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
ratelimitedThe request has been ratelimited. Refer to the Retry-After header for when to retry the request.
request_timeoutThe method was called via a POST request, but the POST data was either missing or truncated.
service_unavailableThe service is temporarily unavailable
team_access_not_grantedThe token used is not granted the specific workspace access required to complete this request.
team_added_to_orgThe 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.
team_not_foundThe team cannot be found.
token_expiredAuthentication token has expired
token_revokedAuthentication token is for a deleted user or workspace or the app has been removed when using a user token.
two_factor_setup_requiredTwo factor setup is required.
user_not_foundThe user cannot be found.