Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.members.json
{
"args": {
"channel": {
"desc": "ID of the conversation to retrieve members for",
"required": true,
"type": "string"
},
"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"
},
"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 users list hasn't been reached.",
"example": "20",
"required": false,
"type": "number"
}
},
"desc": "Retrieve members of a conversation.",
"errors": {
"channel_not_found": "Value passed for `channel` was invalid.",
"fetch_members_failed": "Failed to fetch members for the conversation.",
"invalid_cursor": "Value passed for `cursor` was invalid.",
"invalid_limit": "Value passed for `limit` was invalid.",
"method_not_supported_for_channel_type": "This type of conversation cannot be used with this method."
},
"rate_limit": {
"label": "Tier 4: 100+ 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"
}
]
}
}