Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods usergroups.users.list.json
Raw

priv/docs/methods/usergroups.users.list.json

{
"args": {
"include_disabled": {
"desc": "Include results for disabled User Groups.",
"example": "true",
"required": false,
"type": "boolean"
},
"team_id": {
"desc": "The user group's encoded team ID. Required if org token is used.",
"required": false,
"type": "string"
},
"usergroup": {
"desc": "The encoded ID of the User Group.",
"example": "S0604QSJC",
"required": true,
"type": "string"
}
},
"desc": "List all users in a User Group.",
"errors": {
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"no_such_subteam": "No usergroup found with the given ID.",
"plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "usergroups:read",
"url": "https://docs.slack.dev/reference/scopes/usergroups.read"
}
],
"user": [
{
"name": "usergroups:read",
"url": "https://docs.slack.dev/reference/scopes/usergroups.read"
}
]
}
}