View as Markdown
Slack icon

Slack ACTION

Get Channel Details

Retrieve details for a Slack channel, specified by ID (preferred — resolves instantly) or by name (resolved by scanning the workspace's channel list, which can be slow). See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Slack account once, then configure and run Get Channel Details from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "slack_v2-get-channel-details",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    slack_v2: { authProvisionId: "apn_xxxxxxx" },
    channel: "Channel",
    includeLocale: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Channel Details inputs
Property Type Description
channel Channel string
Prefer a channel ID (e.g. C1234567890) — use List Channels to look it up; it resolves instantly. A channel name (e.g. general or #general) is also accepted, but resolving it scans up to 5 pages (~5,000 channels) of the workspace's channel list, which can be slow — and a valid channel beyond that bound will not be found.
Required
includeLocale Include Locale boolean
Set to true to receive the locale for this channel
Optional
includeNumberOfMembers Include Member Count boolean
Set to true to receive the number of members of this channel
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
slack_v2-get-channel-details
Version
0.1.6
App
Slack
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes