Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.inviteRequests.list.json
Raw

priv/docs/methods/admin.inviteRequests.list.json

{
"args": {
"cursor": {
"desc": "Value of the `next_cursor` field sent as part of the previous API response",
"example": "5cweb43",
"required": false,
"type": "string"
},
"limit": {
"default": "100",
"desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive",
"example": "100",
"required": false,
"type": "integer"
},
"team_id": {
"desc": "ID for the workspace where the invite requests were made.",
"required": false,
"type": "string"
}
},
"desc": "List all pending workspace invite requests.",
"errors": {
"feature_not_enabled": "The Invite Request Admin APIs feature is not enabled",
"not_an_admin": "This token doesn't have admin privileges.",
"team_not_found": "The `team_id` specified wasn't found."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.invites:read",
"url": "https://docs.slack.dev/reference/scopes/admin.invites.read"
}
]
}
}