View as Markdown
Beehiiv icon

Beehiiv ACTION

Get Subscriber

Get full details for a single subscriber by ID or email. Use expand to include stats (open/click rates), custom field values, or referral data. Either subscriptionId or email must be provided. Use Search Subscribers to find subscriber IDs. Use Get Publication Info to get the publication ID. 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 Get Subscriber 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-get-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    publicationId: "Publication ID",
    subscriptionId: "Subscription ID",
  },
})

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 Subscriber inputs
Property Type Description
publicationId Publication ID string
The publication ID. Use Get Publication Info to find this.
Required
subscriptionId Subscription ID string
The subscriber's subscription ID. Use this OR email.
Optional
email Email string
The subscriber's email address. Use this OR subscriptionId.
Optional
expand Expand string[]
Include additional data. 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-get-subscriber
Version
0.0.2
App
Beehiiv
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes