Example Usage of
 contact_automation_list

View automations for a contact

Description: View all automations that are associated with a specific contact.
Endpoint: /admin/api.php?api_action=contact_automation_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.
Variable Description
api_action*contact_automation_list
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
offset*Offset to start returning records from (default is 0)
limit*Limit of records per page (default and maximum is 20)
contact_id*The ID of the contact you want to view automations for (either this or contact_email is required)
contact_email*The email address of the contact you want to view automations for (either this or contact_id is required)
Example response:
Variable Description
0Array
nameSeries 1
status2
adddate2014-04-07 13:33:54
remdate2014-04-07 13:33:54
lastblock7
lastdate2014-04-07 13:33:54
id1
1Array
nameSeries 2
status2
adddate2014-03-22 09:33:54
remdate2014-03-22 12:33:51
lastblock7
lastdate2014-04-07 13:33:54
id2
result_code1
result_messageSuccess: Something is returned
result_outputserialize

PHP Example

This is an example of using the contact_automation_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("contact/automation/list?offset=0&limit=50&contact_id=22");

echo "<pre>";
print_r($response);
echo "</pre>";?>

Questions? Discuss this API call in our developer forum

You can install activecampaign-api-php by downloading (.zip) or cloning the source:

git clone git@github.com:ActiveCampaign/activecampaign-api-php.git