Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.list.json
{
"args": {
"cursor": {
"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.",
"example": "dXNlcjpVMDYxTkZUVDI=",
"required": false,
"type": "string"
},
"exclude_archived": {
"default": "false",
"desc": "Set to `true` to exclude archived channels from the list.",
"example": "true",
"required": false,
"type": "boolean"
},
"limit": {
"default": "100",
"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 under 1000.",
"example": "20",
"required": false,
"type": "number"
},
"team_id": {
"desc": "encoded team id to list channels in, required if token belongs to org-wide app",
"required": false,
"type": "string"
},
"types": {
"default": "public_channel",
"desc": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`",
"example": "public_channel,private_channel",
"required": false,
"type": "string"
}
},
"desc": "Lists all channels in a Slack team.",
"errors": {
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"invalid_limit": "Value passed for `limit` is not understood.",
"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.",
"method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
"missing_argument": "A required argument is missing."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "channels:read",
"url": "https://docs.slack.dev/reference/scopes/channels.read"
},
{
"name": "groups:read",
"url": "https://docs.slack.dev/reference/scopes/groups.read"
},
{
"name": "im:read",
"url": "https://docs.slack.dev/reference/scopes/im.read"
},
{
"name": "mpim:read",
"url": "https://docs.slack.dev/reference/scopes/mpim.read"
}
],
"user": [
{
"name": "channels:read",
"url": "https://docs.slack.dev/reference/scopes/channels.read"
},
{
"name": "groups:read",
"url": "https://docs.slack.dev/reference/scopes/groups.read"
},
{
"name": "im:read",
"url": "https://docs.slack.dev/reference/scopes/im.read"
},
{
"name": "mpim:read",
"url": "https://docs.slack.dev/reference/scopes/mpim.read"
}
]
}
}