List Conversations

Lists all channels in a Slack workspace

Usage #

// Import the typed helper
import { listConversations } from "@hotglue/sdk/slack";
const result = await client.execute({
...listConversations({
types: string,
exclude_archived: bool,
limit: int,
// ...
}),
userId: "user_123",
});
// result is typed as ListConversationsOutput
const result = await client.execute({
integration: "slack",
tool: "list_conversations",
userId: "user_123",
input: {
types: string,
exclude_archived: bool,
limit: int,
// ...
},
});
// 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 Conversations tool");

Required Permissions #

channels:read

Input Schema #

types string

Comma-separated list of channel types: public_channel, private_channel, mpim, im

default: public_channel
exclude_archived bool

Exclude archived channels

default: true
limit int

Maximum number of items to return (max 1000)

default: 100
cursor string

Pagination cursor for next page of results

Output Schema #

ok bool required
channels object[]
response_metadata object

This tool calls: #

GET https://slack.com/api/conversations.list