slackLists.items.list method
Usage info
Lists are only available to Slack workspaces on a paid plan.
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
}
}