Skip to main content

pins.list method

Welcome to the new home of Slack developer docs!

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 lists the items pinned to a channel.

Response

The response contains a list of pinned items in a channel. Different item types can be pinned. Every item in the list has a type property, and the other properties depend on the type of item. The possible types are:

  • message: the item will have a message property containing a message object and a channel property containing the channel ID for the message.
  • file: 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.

The created property on each item is a Unix timestamp representing when the item was pinned. The created_by property on each item is a string representing the encoded user id of the user who pinned the item.