ActiveCampaignFind contacts
Finds ActiveCampaign contacts by e-mail, list, tag, segment or free text.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The ActiveCampaign connection the step signs in with. |
| E-mail address | The whole address, matched exactly. |
| E-mail contains | Part of an address — everyone at one domain, for instance. |
| On list | Picked from the list ActiveCampaign offers. |
| With tag id | text |
| In segment | text |
| In automation | The List automations node answers this id. |
| Subscription status | "any" or "unconfirmed" or "active" or "unsubscribed" or "bounced" |
| Free text | Matches names, addresses and phone numbers. |
| Created after | text |
| Created before | text |
| Updated after | text |
| Updated before | text |
| Contacts per call | 1 to 100. ActiveCampaign's own default is 20. |
| Start at | Zero-based. Ignored while every page is fetched. |
| Fetch every page | Walks the whole result, and refuses past 5,000 contacts rather than answering a short list. ActiveCampaign allows the whole account five requests a second, so that walk is 50 calls and ten seconds at best. |
| Use ActiveCampaign's fast paging | Walks by ascending id instead of by offset, which is what ActiveCampaign recommends: accounts with many contacts get slower answers as the offset grows. Turn it off for a stable offset window. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `activecampaign`) |
email | text |
emailLike | text |
listId | texta value from the vendor's own list |
tagId | text |
segmentId | text |
automationId | text |
status | "any" or "unconfirmed" or "active" or "unsubscribed" or "bounced", by default "any" |
search | text |
createdAfter | text |
createdBefore | text |
updatedAfter | text |
updatedBefore | text |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |
fastPaging | true/false, by default trueused when `returnAll` is true |
cursor | text |
Output
| Field | Type |
|---|---|
contacts | array |
contactCountContacts in this answer | number |
totalContacts the search matches | number |
hasMoreMore contacts are waiting | boolean |
nextOffsetOffset for the next page | number |
relatedSide-loaded relations | object |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- contactCount0
- contacts[]
- hasMorefalse
- nextOffset0
- related{}
- total0
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"automationId": "",
"connection": "<connection id>",
"createdAfter": "",
"createdBefore": "",
"cursor": "",
"email": "",
"emailLike": "",
"fastPaging": true,
"limit": 100,
"listId": "",
"offset": 0,
"returnAll": false,
"search": "",
"segmentId": "",
"status": "any",
"tagId": "",
"updatedAfter": "",
"updatedBefore": ""
},
"label": "Find contacts",
"type": "activecampaign.listContacts",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The ActiveCampaign connection the step signs in with. |
| E-mail address | The whole address, matched exactly. |
| E-mail contains | Part of an address — everyone at one domain, for instance. |
| On list | Picked from the list ActiveCampaign offers. |
| With tag id | text |
| In segment | text |
| In automation | The List automations node answers this id. |
| Subscription status | "any" or "unconfirmed" or "active" or "unsubscribed" or "bounced" |
| Free text | Matches names, addresses and phone numbers. |
| Created after | text |
| Created before | text |
| Updated after | text |
| Updated before | text |
| Contacts per call | 1 to 100. ActiveCampaign's own default is 20. |
| Start at | Zero-based. Ignored while every page is fetched. |
| Fetch every page | Walks the whole result, and refuses past 5,000 contacts rather than answering a short list. ActiveCampaign allows the whole account five requests a second, so that walk is 50 calls and ten seconds at best. |
| Use ActiveCampaign's fast paging | Walks by ascending id instead of by offset, which is what ActiveCampaign recommends: accounts with many contacts get slower answers as the offset grows. Turn it off for a stable offset window. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `activecampaign`) |
email | text |
emailLike | text |
listId | texta value from the vendor's own list |
tagId | text |
segmentId | text |
automationId | text |
status | "any" or "unconfirmed" or "active" or "unsubscribed" or "bounced", by default "any" |
search | text |
createdAfter | text |
createdBefore | text |
updatedAfter | text |
updatedBefore | text |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |
fastPaging | true/false, by default trueused when `returnAll` is true |