List User Group Users

Lists all users in a user group

Usage #

// Import the typed helper
import { listUsergroupUsers } from "@hotglue/sdk/slack";
const result = await client.execute({
...listUsergroupUsers({
usergroup: string,
include_disabled: bool,
}),
userId: "user_123",
});
// result is typed as ListUsergroupUsersOutput
const result = await client.execute({
integration: "slack",
tool: "list_usergroup_users",
userId: "user_123",
input: {
usergroup: string,
include_disabled: bool,
},
});
// The agent will automatically use this tool when needed
const agent = new Agent({
tools: () => hotglueTools({
integrations: ["slack"],
userId: "user_123",
}),
});
await agent.generate("run the List User Group Users tool");

Required Permissions #

usergroups:read

Input Schema #

usergroup string required

User group ID

include_disabled bool

Include disabled users

default: false

Output Schema #

ok bool required
users string[]

This tool calls: #

GET https://slack.com/api/usergroups.users.list