Skip to main content

lib/slack/web/docs/users.conversations.json

{
  "desc": "Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.",

  "args": {
    "cursor": {
      "example" : "dXNlcjpVMDYxTkZUVDI=",
      "required": false,
      "desc"    : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail."
    },
    "exclude_archived": {
      "example" : "true",
      "required": false,
      "desc"    : "Set this to `true` to exclude archived channels from the list",
      "default" : "false"
    },
    "limit": {
      "example" : 20,
      "required": false,
      "desc"    : "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. Must be an integer no larger than 1000.",
      "default" : 100
    },
    "types": {
      "example" : "public_channel,private_channel",
      "required": false,
      "desc"    : "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`",
      "default" : "public_channel"
    },
    "user": {
      "example" : "W0B2345D",
      "required": false,
      "desc"    : "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
    }
  },

  "errors": {
    "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method."
  }
}