View as Markdown
ConvertKit icon

ConvertKit ACTION

List subscribers

Returns a list of your subscribers. See docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ConvertKit account once, then configure and run List subscribers 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: "convertkit-list-subscribers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    convertkit: { authProvisionId: "apn_xxxxxxx" },
    emailAddress: "Email address",
    page: 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 subscribers inputs
Property Type Description
emailAddress Email address string
Search subscribers by email address
Optional
page Page integer
Page for paginated results
Optional
from Start date string
Filter subscribers added on or after this date (format yyyy-mm-dd)
Optional
to End date string
Filter subscribers added on or before this date (format yyyy-mm-dd)
Optional
sortOrder Sort order string
Sort order for results
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
convertkit-list-subscribers
Version
0.0.3
App
ConvertKit
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes