List All Contacts with ActiveCampaign API

Pipedream makes it easy to connect APIs for ActiveCampaign and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List All Contacts with the ActiveCampaign API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to List All Contacts with the ActiveCampaign API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List All Contacts action
1. Connect your ActiveCampaign account
2. Optional- Configure IDs
3. Optional- Configure Email
4. Optional- Configure Email Like
5. Optional- Configure Excluded Contact ID
6. Optional- Configure Form ID
7. Optional- Configure Greater Contact ID
8. Optional- Configure Less Contact ID
9. Optional- Configure List ID
10. Optional- Configure Organization
11. Optional- Configure Search
12. Optional- Configure Segment ID
13. Optional- Configure Series ID
14. Optional- Configure Status
15. Optional- Configure Tag ID
16. Optional- Configure Created Before
17. Optional- Configure Created After
18. Optional- Configure Updated Before
19. Optional- Configure Updated After
20. Optional- Configure Wait ID
21. Optional- Select a Order By Creation Date
22. Optional- Select a Order By Email
23. Optional- Select a Order By First Name
24. Optional- Select a Order By Last Name
25. Optional- Select a Order By Name
26. Optional- Select a Order By Score
27. Optional- Configure In Group Lists
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List All Contacts with ActiveCampaign API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ActiveCampaign

Try it

List All Contacts with ActiveCampaign API on New Item in Feed from RSS API

RSS + ActiveCampaign

Try it

List All Contacts with ActiveCampaign API on New Message from Discord API

Discord + ActiveCampaign

Try it

List All Contacts with ActiveCampaign API on New Message In Channels from Slack API

Slack + ActiveCampaign

Try it

List All Contacts with ActiveCampaign API on New Message in Channel from Discord Bot API

Discord Bot + ActiveCampaign

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List All Contacts on ActiveCampaign

Description:Retrieve all existing contacts. See the docs [here](https://developers.activecampaign.com/reference/list-all-contacts).

Version:0.2.0

Key:activecampaign-list-all-contacts

View on GitHub

Code#

import activecampaign from "../../activecampaign.app.mjs";

export default {
  key: "activecampaign-list-all-contacts",
  name: "List All Contacts",
  description: "Retrieve all existing contacts. See the docs [here](https://developers.activecampaign.com/reference/list-all-contacts).",
  version: "0.2.0",
  type: "action",
  props: {
    activecampaign,
    ids: {
      type: "string",
      label: "IDs",
      description: "Filter contacts by ID. Can be repeated for multiple IDs. Example: ids[]=1&ids[]=2&ids[]=42",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the contact you want to get",
      optional: true,
    },
    emailLike: {
      type: "string",
      label: "Email Like",
      description: "Filter contacts that contain the given value in the email address",
      optional: true,
    },
    exclude: {
      type: "string",
      label: "Excluded Contact ID",
      description: "Exclude from the response the contact with the given ID",
      optional: true,
    },
    formid: {
      type: "string",
      label: "Form ID",
      description: "Filter contacts associated with the given form",
      optional: true,
    },
    idGreater: {
      type: "string",
      label: "Greater Contact ID",
      description: "Only include contacts with an ID greater than the given ID",
      optional: true,
    },
    idLess: {
      type: "string",
      label: "Less Contact ID",
      description: "Only include contacts with an ID less than the given ID",
      optional: true,
    },
    listid: {
      type: "string",
      label: "List ID",
      description: "Filter contacts associated with the given list",
      optional: true,
    },
    organization: {
      type: "string",
      label: "Organization",
      description: "(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID",
      optional: true,
    },
    search: {
      type: "string",
      label: "Search",
      description: "Filter contacts that match the given value in the contact names, organization, phone or email",
      optional: true,
    },
    segmentid: {
      type: "string",
      label: "Segment ID",
      description: "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: true,
    },
    seriesid: {
      type: "string",
      label: "Series ID",
      description: "Filter contacts associated with the given automation",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "See [available values](https://developers.activecampaign.com/reference#section-contact-parameters-available-values)",
      optional: true,
    },
    tagid: {
      type: "string",
      label: "Tag ID",
      description: "Filter contacts associated with the given tag",
      optional: true,
    },
    createdBefore: {
      type: "string",
      label: "Created Before",
      description: "Filter contacts that were created prior to this date",
      optional: true,
    },
    createdAfter: {
      type: "string",
      label: "Created After",
      description: "Filter contacts that were created after this date",
      optional: true,
    },
    updatedBefore: {
      type: "string",
      label: "Updated Before",
      description: "Filter contacts that were updated before this date",
      optional: true,
    },
    updatedAfter: {
      type: "string",
      label: "Updated After",
      description: "Filter contacts that were updated after this date",
      optional: true,
    },
    waitid: {
      type: "string",
      label: "Wait ID",
      description: "Filter by contacts in the wait queue of an automation block",
      optional: true,
    },
    orderByCreationDate: {
      type: "string",
      label: "Order By Creation Date",
      description: "Order contacts by creation date",
      optional: true,
      options: [
        "ASC",
        "DESC",
      ],
    },
    orderByEmail: {
      type: "string",
      label: "Order By Email",
      description: "Order contacts by email",
      optional: true,
      options: [
        "ASC",
        "DESC",
      ],
    },
    orderByFirstName: {
      type: "string",
      label: "Order By First Name",
      description: "Order contacts by first name",
      optional: true,
      options: [
        "ASC",
        "DESC",
      ],
    },
    orderByLastName: {
      type: "string",
      label: "Order By Last Name",
      description: "Order contacts by last name",
      optional: true,
      options: [
        "ASC",
        "DESC",
      ],
    },
    orderByName: {
      type: "string",
      label: "Order By Name",
      description: "Order contacts by full name",
      optional: true,
      options: [
        "ASC",
        "DESC",
      ],
    },
    orderByScore: {
      type: "string",
      label: "Order By Score",
      description: "Order contacts by score",
      optional: true,
      options: [
        "ASC",
        "DESC",
      ],
    },
    inGroupLists: {
      type: "string",
      label: "In Group Lists",
      description: "Set this to `true` in order to return only contacts that the current user has permissions to see.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      ids,
      email,
      emailLike,
      exclude,
      formid,
      idGreater,
      idLess,
      listid,
      organization,
      search,
      segmentid,
      seriesid,
      status,
      tagid,
      createdBefore,
      createdAfter,
      updatedBefore,
      updatedAfter,
      waitid,
      orderByCreationDate,
      orderByEmail,
      orderByFirstName,
      orderByLastName,
      orderByName,
      orderByScore,
      inGroupLists,
    } = this;

    const response = await this.activecampaign.listContacts({
      params: {
        ids,
        email,
        "email_like": emailLike,
        exclude,
        formid,
        "id_greater": idGreater,
        "id_less": idLess,
        listid,
        organization,
        search,
        segmentid,
        seriesid,
        status,
        tagid,
        "filters[created_before]": createdBefore,
        "filters[created_after]": createdAfter,
        "filters[updated_before]": updatedBefore,
        "filters[updated_after]": updatedAfter,
        waitid,
        "orders[cdate]": orderByCreationDate,
        "orders[email]": orderByEmail,
        "orders[first_name]": orderByFirstName,
        "orders[last_name]": orderByLastName,
        "orders[name]": orderByName,
        "orders[score]": orderByScore,
        "in_group_lists": inGroupLists,
      },
    });

    $.export("$summary", `Successfully listed ${response.contacts.length} contact(s)`);

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
ActiveCampaign	`activecampaign`	`app`	This component uses the ActiveCampaign app.
IDs	`ids`	`string`	Filter contacts by ID. Can be repeated for multiple IDs. Example: ids[]=1&ids[]=2&ids[]=42
Email	`email`	`string`	Email address of the contact you want to get
Email Like	`emailLike`	`string`	Filter contacts that contain the given value in the email address
Excluded Contact ID	`exclude`	`string`	Exclude from the response the contact with the given ID
Form ID	`formid`	`string`	Filter contacts associated with the given form
Greater Contact ID	`idGreater`	`string`	Only include contacts with an ID greater than the given ID
Less Contact ID	`idLess`	`string`	Only include contacts with an ID less than the given ID
List ID	`listid`	`string`	Filter contacts associated with the given list
Organization	`organization`	`string`	(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID
Search	`search`	`string`	Filter contacts that match the given value in the contact names, organization, phone or email
Segment ID	`segmentid`	`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)
Series ID	`seriesid`	`string`	Filter contacts associated with the given automation
Status	`status`	`string`	See available values
Tag ID	`tagid`	`string`	Filter contacts associated with the given tag
Created Before	`createdBefore`	`string`	Filter contacts that were created prior to this date
Created After	`createdAfter`	`string`	Filter contacts that were created after this date
Updated Before	`updatedBefore`	`string`	Filter contacts that were updated before this date
Updated After	`updatedAfter`	`string`	Filter contacts that were updated after this date
Wait ID	`waitid`	`string`	Filter by contacts in the wait queue of an automation block
Order By Creation Date	`orderByCreationDate`	`string`	Select a value from the drop down menu:`ASCDESC`
Order By Email	`orderByEmail`	`string`	Select a value from the drop down menu:`ASCDESC`
Order By First Name	`orderByFirstName`	`string`	Select a value from the drop down menu:`ASCDESC`
Order By Last Name	`orderByLastName`	`string`	Select a value from the drop down menu:`ASCDESC`
Order By Name	`orderByName`	`string`	Select a value from the drop down menu:`ASCDESC`
Order By Score	`orderByScore`	`string`	Select a value from the drop down menu:`ASCDESC`
In Group Lists	`inGroupLists`	`string`	Set this to `true` in order to return only contacts that the current user has permissions to see.