View as Markdown
Beehiiv icon

Beehiiv ACTION

List Segments

List subscriber segments for a publication. Segments are pre-defined subscriber groups (dynamic rules, static lists, or manual selections). Use this for discovery — to understand how subscribers are organized. 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 List Segments 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-list-segments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    publicationId: "Publication ID",
    type: "Segment Type",
  },
})

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 Segments inputs
Property Type Description
publicationId Publication ID string
The publication ID. Use Get Publication Info to find this.
Required
type Segment Type string
Filter segments by type. Options: dynamic, static, manual, all. Default: all.
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-list-segments
Version
0.0.2
App
Beehiiv
Authentication
API key
Read-only
Yes
Destructive
No
Open world
No