View as Markdown
ActiveCampaign icon

ActiveCampaign ACTION

List All Contacts

Retrieve all existing contacts. See the docs here.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

List All Contacts inputs
Property Type Description
ids IDs string
Filter contacts by ID. Can be repeated for multiple IDs. Example: ids[]=1&ids[]=2&ids[]=42
Optional
email Email string
Email address of the contact you want to get
Optional
emailLike Email Like string
Filter contacts that contain the given value in the email address
Optional
exclude Excluded Contact ID string
Exclude from the response the contact with the given ID
Optional
formid Form ID string
Filter contacts associated with the given form
Optional
idGreater Greater Contact ID string
Only include contacts with an ID greater than the given ID
Optional
idLess Less Contact ID string
Only include contacts with an ID less than the given ID
Optional
listid List ID string
Filter contacts associated with the given list
Optional
organization Organization string
(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID
Optional
search Search string
Filter contacts that match the given value in the contact names, organization, phone or email
Optional
segmentid Segment ID string
Return only contacts that match a list segment (this param initially returns segment information, when it is run a second time it will return contacts that match the segment)
Optional
seriesid Series ID string
Filter contacts associated with the given automation
Optional
status Status string
Optional
tagid Tag ID string
Filter contacts associated with the given tag
Optional
createdBefore Created Before string
Filter contacts that were created prior to this date
Optional
createdAfter Created After string
Filter contacts that were created after this date
Optional
updatedBefore Updated Before string
Filter contacts that were updated before this date
Optional
updatedAfter Updated After string
Filter contacts that were updated after this date
Optional
waitid Wait ID string
Filter by contacts in the wait queue of an automation block
Optional
orderByCreationDate Order By Creation Date string
Order contacts by creation date
Optional
orderByEmail Order By Email string
Order contacts by email
Optional
orderByFirstName Order By First Name string
Order contacts by first name
Optional
orderByLastName Order By Last Name string
Order contacts by last name
Optional
orderByName Order By Name string
Order contacts by full name
Optional
orderByScore Order By Score string
Order contacts by score
Optional
inGroupLists In Group Lists string
Set this to true in order to return only contacts that the current user has permissions to see.
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
activecampaign-list-all-contacts
Version
0.2.2
App
ActiveCampaign
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes