Description Usage Arguments Value See Also Examples
View source: R/ac_get_contacts.R
Contacts are the center of activity in 'ActiveCampaign' and represent the people that the owner of an 'ActiveCampaign' account is marketing to or selling to.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | ac_get_contacts(
ids = NULL,
email = NULL,
email_like = NULL,
exclude = NULL,
formid = NULL,
id_greater = NULL,
id_less = NULL,
listid = NULL,
search = NULL,
segmentid = NULL,
seriesid = NULL,
status = NULL,
tagid = NULL,
created_before = NULL,
created_after = NULL,
updated_before = NULL,
updated_after = NULL,
waitid = NULL,
in_group_lists = NULL
)
|
ids |
Filter contacts by ID. Can be repeated for multiple IDs. |
email |
Email address of the contact you want to get |
email_like |
Filter contacts that contain the given value in the email address |
exclude |
Exclude from the response the contact with the given ID |
formid |
Filter contacts associated with the given form |
id_greater |
Only include contacts with an ID greater than the given ID |
id_less |
Only include contacts with an ID less than the given ID |
listid |
Filter contacts associated with the given list |
search |
Filter contacts that match the given value in the contact names, organization, phone or email |
segmentid |
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) |
seriesid |
Filter contacts associated with the given automation |
status |
Filter contact by status: -1 - Any, 0 - Unconfirmed, 1 - Active, 2 - Unsubscribed, 3 - Bounced |
tagid |
Filter contacts associated with the given tag |
created_before |
Filter contacts that were created prior to this date |
created_after |
Filter contacts that were created after this date |
updated_before |
Filter contacts that were updated before this date |
updated_after |
Filter contacts that were updated after this date |
waitid |
Filter by contacts in the wait queue of an automation block |
in_group_lists |
Set this to TRUE in order to return only contacts that the current user has permissions to see. |
tibble with contacts metadata
1 2 3 4 5 6 7 | ## Not run:
Sys.setenv('ACTIVECAMPAGN_API_TOKEN' = "YOUR_TOKEN")
Sys.setenv('ACTIVECAMPAGN_API_URL' = "https://<your-account>.api-us1.com")
contacts <- ac_get_contacts()
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.