Sample - Slack Web API
GET/usergroups.list

List User Groups

Lists the User Groups available for a team. Use the inclusion flags to return member lists, member counts, or disabled User Groups alongside the default User Group details.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters
include_usersbooleanoptional
Whether to include the list of users in each User Group.
tokenstringrequired
Authentication token with the `usergroups:read` scope.
include_countbooleanoptional
Whether to include the number of users in each User Group.
include_disabledbooleanoptional
Whether to include disabled User Groups in the results.

2 status codes
200Returns an array of User Group objects, each containing its identifier, name, description, handle, team association, and status metadata.
okbooleanrequired
Allowed:true
usergroupsarray<SubteamUsergroupObject>required
defaultTypical error response
callstackstringoptional
Note: PHP callstack is only visible in dev/qa
errorstringrequired
Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botuser_is_restrictedinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_data
okbooleanrequired
Allowed:false

Error handling

Send an authentication token with the usergroups:read scope. include_users, include_count, and include_disabled must be boolean values when provided.