Developers

Example Usage of
automation_contact_view

View a single contact in an automation

Description: View more information about a single contact in a specific automation.
Endpoint: /admin/api.php?api_action=automation_contact_view
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*automation_contact_view
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
contact_idThe ID of the contact you want to view within an automation
automationThe ID of the automation to view the contact in
Example response:
Variable Description
0Array
id4976
emailabc@def.com
automation_status1
adddate2014-04-07 13:59:44
remdate2014-04-07 16:44:59
lastblock7
lastdate2014-04-07 13:59:44
automation_logArray
0Array
blockid7
tstamp2014-04-07 13:33:54
res1
1Array
blockid8
tstamp2014-04-07 13:33:54
res1
result_code1
result_messageSuccess: Something is returned
result_outputserialize

PHP Example

This is an example of using the automation_contact_view 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/view?contact_id=4976&automation=3");

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

Questions? Discuss this API call in our developer forum