View as Markdown
Mailchimp icon

Mailchimp ACTION

Get List

Searches for lists. See docs here
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mailchimp account once, then configure and run Get List 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: "mailchimp-get-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mailchimp: { authProvisionId: "apn_xxxxxxx" },
    listId: "List Id",
    fields: ["Fields"],
  },
})

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 List inputs
Property Type Description
listId List Id string
The unique ID of the list
Required Dynamic
fields Fields string[]
A string list of fields to return. Reference parameters of sub-objects with dot notation.
Optional
excludeFields Exclude Fields string[]
A string list of fields to exclude_fields. Reference parameters of sub-objects with dot notation.
Optional
includeTotalContacts Include total contacts boolean
Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.
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
mailchimp-get-list
Version
0.0.3
App
Mailchimp
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes