View as Markdown
Slack icon

Slack ACTION

List Users

Return a list of all users in a workspace. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Slack account once, then configure and run List Users 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-list-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    slack_v2: { authProvisionId: "apn_xxxxxxx" },
    teamId: "Team",
    pageSize: 10,
  },
})

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.

List Users inputs
Property Type Description
teamId Team string
The encoded team ID (e.g. T1234567890). Only required when the connected token spans multiple teams (Enterprise Grid); omit otherwise. Use List Teams to find valid IDs.
Optional
pageSize Page Size integer
The number of results to include in a page. Default: 250
Optional
numPages Number of Pages integer
The number of pages to retrieve. Default: 1
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-list-users
Version
0.0.35
App
Slack
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes