Current section
Files
Jump to
Current section
Files
priv/docs/methods/usergroups.list.json
{
"args": {
"include_count": {
"desc": "Include the number of users in each User Group.",
"example": "true",
"required": false,
"type": "boolean"
},
"include_disabled": {
"desc": "Include results for disabled User Groups.",
"example": "true",
"required": false,
"type": "boolean"
},
"include_users": {
"desc": "Include the list of users for each User Group.",
"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"
}
},
"desc": "List all User Groups for a team.",
"errors": {
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"invalid_team": "Cannot find subteam team.",
"missing_argument": "A required argument is missing.",
"plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.",
"users_not_found": "Cannot find users on subteam."
},
"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"
}
]
}
}