View as Markdown
Beehiiv icon

Beehiiv ACTION

Search Subscribers

Search and filter subscribers for a publication. Use email for exact email lookup, or combine status and tier filters to narrow results. Use Get Publication Info to get the publication ID. For full details on a single subscriber (with stats, custom fields, referrals), use Get Subscriber instead. Use List Custom Fields to discover available custom field names. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Beehiiv account once, then configure and run Search 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: "beehiiv-search-subscribers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    publicationId: "Publication ID",
    email: "Email",
  },
})

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.

Search Subscribers inputs
Property Type Description
publicationId Publication ID string
The publication ID. Use Get Publication Info to find this.
Required
email Email string
Filter by exact email address (case-insensitive).
Optional
status Status string
Filter by subscription status. Options: validating, invalid, pending, active, inactive, all. Default: all.
Optional
tier Tier string
Filter by subscription tier. Options: free, premium, all. Default: all.
Optional
limit Limit integer
Number of results per page (1-100). Default: 10.
Optional
cursor Cursor string
Pagination cursor from a previous response for the next page of results.
Optional
expand Expand string[]
Include additional data for each subscriber. Options: stats, custom_fields, referrals, subscription_premium_tiers.
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
beehiiv-search-subscribers
Version
0.0.2
App
Beehiiv
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes