View as Markdown
Discord Bot icon

Discord Bot ACTION

List Guild Members

Return a list of guild members. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Discord Bot account once, then configure and run List Guild Members 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: "discord_bot-list-guild-members",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    discord_bot: { authProvisionId: "apn_xxxxxxx" },
    guildId: "Guild",
    max: 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 Guild Members inputs
Property Type Description
guildId Guild string
In order to get members you might want to take a look at these docs.
Required Dynamic
max Max records integer
Max number of records in the whole pagination (eg. 60)
Optional
limit Limit integer
Max number of members to return per page (1-1000)
Optional
after After string
The highest user id in the previous page
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
discord_bot-list-guild-members
Version
1.0.1
App
Discord Bot
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes