---
title: "GET /usergroups.list"
method: GET
path: "/usergroups.list"
tags: ["usergroups"]
---

# GET /usergroups.list

`GET /usergroups.list`

List all User Groups for a team

## Query parameters

- `include_users` boolean
- `token` string, required
- `include_count` boolean
- `include_disabled` boolean

## Response `200`

Typical success response

- object — Schema for successful response from usergroups.list method
  - `ok` true, required
  - `usergroups` ObjsSubteam[], required
    - `auto_provision` boolean, required
    - `auto_type` union[], required
      - union
        - unknown
        - 'owner' | 'admin'
    - `channel_count` integer
    - `created_by` string, required
    - `date_create` integer, required
    - `date_delete` integer, required
    - `date_update` integer, required
    - `deleted_by` union[], required
      - union
        - unknown
        - string
    - `description` string, required
    - `enterprise_subteam_id` string, required
    - `handle` string, required
    - `id` string, required
    - `is_external` boolean, required
    - `is_subteam` boolean, required
    - `is_usergroup` boolean, required
    - `name` string, required
    - `prefs` object, required
      - `channels` DefsChannelId[], required
      - `groups` DefsGroupId[], required
    - `team_id` string, required
    - `updated_by` string, required
    - `user_count` integer
    - `users` DefsUserId[]

## Other responses

- `default` — Typical error response

---

[API](https://skmtc.net/slack/apis/web-api.md) · [All operations](https://skmtc.net/slack/apis/web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slack/web-api/revisions/7b951462b44f/schema)