View as Markdown
Postalytics icon

Postalytics ACTION

List Contacts

Displays a list of contacts in Postalytics. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Postalytics account once, then configure and run List Contacts 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: "postalytics-list-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    postalytics: { authProvisionId: "apn_xxxxxxx" },
    listId: "List 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.

List Contacts inputs
Property Type Description
listId List ID string
The unique identifier for a contact list
Required Dynamic

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
postalytics-list-contacts
Version
0.0.2
App
Postalytics
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes