/usergroups.list

https://slack.com/usergroups.list

List all User Groups for a team

Access Token Required: API Key

Query Params

include_usersstring

Include the list of users for each User Group.

tokenstringrequired

Authentication token. Requires scope: `usergroups:read`

include_countstring

Include the number of users in each User Group.

include_disabledstring

Include disabled User Groups.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://slack.com/usergroups.list' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET