Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods conversations.requestSharedInvite.list.json
Raw

priv/docs/methods/conversations.requestSharedInvite.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`. See pagination for more detail.",
"example": "bG9nX2lkOjc5NjQ1NA==",
"required": false,
"type": "string"
},
"include_approved": {
"desc": "When true approved invitation requests will be returned, otherwise they will be excluded",
"required": false,
"type": "boolean"
},
"include_denied": {
"desc": "When true denied invitation requests will be returned, otherwise they will be excluded",
"required": false,
"type": "boolean"
},
"include_expired": {
"desc": "When true expired invitation requests will be returned, otherwise they will be excluded",
"required": false,
"type": "boolean"
},
"invite_ids": {
"desc": "An optional list of invitation ids to look up",
"required": false,
"type": "array"
},
"limit": {
"default": "200",
"desc": "The number of items to return. Must be between 1 - 1000 (inclusive).",
"required": false,
"type": "integer"
},
"user_id": {
"desc": "Optional filter to return invitation requests for the inviting user.",
"required": false
}
},
"desc": "Lists requests to add external users to channels with ability to filter.",
"errors": {
"invalid_cursor": "The provided cursor is not valid.",
"not_implemented": "its not implemented! TODO: remove me",
"restricted_action": "A team preference prevents the user from listing invitation requests."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "conversations.connect:manage",
"url": "https://docs.slack.dev/reference/scopes/conversations.connect.manage"
}
]
}
}