Skip to main content

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

{
  "desc": "Returns a list of all channel-like conversations in a workspace.",

  "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"
    }
  },

  "errors": {
    "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
    "invalid_limit": "Value passed for `limit` was invalid.",
    "invalid_cursor": "Value passed for `cursor` was invalid.",
    "invalid_types": "Value passed for type could not be used based on the method's capabilities or the permission scopes granted to the used token."
  }
}