List user groups - Automate.ax

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

Example

automations/list-user-groups.automation.ts

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.