Example Usage of automation_contact_list
View contacts from an automation
| Description: | View all contacts that are part of a specific automation. | ||||||||||||||||||||||||||||||||||||||||
| Endpoint: |
/admin/api.php?api_action=automation_contact_list
|
||||||||||||||||||||||||||||||||||||||||
| HTTP method: | GET |
||||||||||||||||||||||||||||||||||||||||
| Supported output formats: | xml, json, serialize |
||||||||||||||||||||||||||||||||||||||||
| Requires authentication: | true |
||||||||||||||||||||||||||||||||||||||||
| Parameters: |
* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/x-www-form-urlencoded. We don't accept any other input formats like JSON.
|
||||||||||||||||||||||||||||||||||||||||
| Example response: |
|
PHP Example
This is an example of using the automation_contact_list call with PHP.
You can replicate the same idea in virtually any other programming language.
The example shown is using serialize as the output format.
You can change that to XML or JSON if you would like.
<?php
// Set up an object instance using our PHP API wrapper.
define("ACTIVECAMPAIGN_URL", "https://{ACCOUNT}.api-us1.com");
define("ACTIVECAMPAIGN_API_KEY", "{API_KEY}");
require_once("../activecampaign-api-php/includes/ActiveCampaign.class.php");
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);
$response = $ac->api("automation/contact/list?automation=3&offset=0&limit=50");
echo "<pre>";
print_r($response);
echo "</pre>";?>
Questions? Discuss this API call in our developer forum