> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# List user groups

> List Slack user groups in the current workspace.

`slack.listUserGroups` lists workspace user groups and their channel preferences.

## Example

```ts automations/list-user-groups.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { slack } from "automate.ax/slack"

export default automation("List user groups", () => {
  onDashboardRun({ title: "List user groups" })

  slack.listUserGroups({ includeCount: true, includeUsers: true })
})
```

## Inputs

| Input             | Type      | Required | Description              |
| ----------------- | --------- | -------- | ------------------------ |
| `includeCount`    | `boolean` | No       | Include member counts.   |
| `includeDisabled` | `boolean` | No       | Include disabled groups. |
| `includeUsers`    | `boolean` | No       | Include member IDs.      |

## Output

Returns normalized user groups with IDs, names, handles, state, audit metadata, channel preferences, and requested membership fields. Requires `usergroups:read` and a Slack plan that supports user groups.