* 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_view
api_output
xml, json, or serialize (default is XML)
id*
ID of the contact you want to view
Example response:
Variable
Description
id
ID of the contact. Example: 2
subscriberid
ID of the contact. Example: 2
listid
ID of the list this contact is part of. Example: 1
formid
Subscription form ID used when subscribing. Example: 0
sdate
Date subscribed. Example: 2011-03-09 09:59:12
udate
Date unsubscribed. Example: 2011-03-08 14:24:44
status
Status for this list. Example: 1
responder
1
sync
0
unsubreason
Unsubscribe reason.
unsubcampaignid
Campaign sent when unsubscribed. Example: 10
unsubmessageid
Message sent when unsubscribed. Example: 1
first_name
First name of contact. Example: Name
last_name
Last name of contact. Example: One
customer_acct_id
ID of the contact's organization. Example: 1
customer_acct_name
Name of the contact's organization. Example: ACME, Inc.
cdate
Date subscribed. Example: 2011-03-02 14:47:01
email
Email address of contact. Example: test@testing.com
bounced_hard
Number of times this contact has hard-bounced. Example: 0
bounced_soft
Number of times this contact has soft-bounced. Example: 0
bounced_date
Date of most recent bounce for this contact.
campaign_history
Array
ip
IP address of the contact. Example: 38.104.242.98
hash
Unique hash for the contact. Example: dfdsfdsfefr345345wfdrs3r
socialdata_lastcheck
Last time social data was fetched for this contact.
lid
1
name
Full name of this contact. Example: Name One
a_unsub_date
2011-03-08
a_unsub_time
14:24:44
lists
Array
listslist
String of lists for this contact. Example: 1
fields
Array
actions
Array
bounces
Array
bouncescnt
Number of total bounces for this contact. Example: 0
tags
Tags assigned to contact.
result_code
Whether or not the response was successful. Examples: 1 = yes, 0 = no
result_message
A custom message that appears explaining what happened. Example: Something is returned
result_output
The result output used. Example: serialize
PHP Example
This is an example of using the 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
// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result
$url = 'https://account.api-us1.com';
// the API Key can be found on the "Your Settings" page under the "API" tab.
// replace this with your API Key
$api_key = 'YOUR_API_KEY';
$params = array(
// this is the action that fetches a contact info based on the ID you provide
'api_action' => 'contact_view',
// define the type of output you wish to get back
// possible values:
// - 'xml' : you have to write your own XML parser
// - 'json' : data is returned in JSON format and can be decoded with
// json_decode() function (included in PHP since 5.2.0)
// - 'serialize' : data is returned in a serialized format and can be decoded with
// a native unserialize() function
'api_output' => 'serialize',
// ID of the contact you wish to fetch
'id' => 1,
);
// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');
// clean up the url
$url = rtrim($url, '/ ');
// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');
// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
die('JSON not supported. (introduced in PHP 5.2.0)');
}
// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;
$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HTTPHEADER, array('API-TOKEN: ' . $api_key)); // Provide the API Token via the API-TOKEN header
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);
$response = (string)curl_exec($request); // execute curl fetch and store results in $response
// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object
if ( !$response ) {
die('Nothing was returned. Do you have a connection to Email Marketing server?');
}
// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...
// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';
// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';
// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';
// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;?>
<?php
// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result $url = 'https://account.api-us1.com';
// the API Key can be found on the "Your Settings" page under the "API" tab. // replace this with your API Key $api_key = 'YOUR_API_KEY';
$params = array(
// this is the action that fetches a contact info based on the ID you provide 'api_action' => 'contact_view',
// define the type of output you wish to get back // possible values: // - 'xml' : you have to write your own XML parser // - 'json' : data is returned in JSON format and can be decoded with // json_decode() function (included in PHP since 5.2.0) // - 'serialize' : data is returned in a serialized format and can be decoded with // a native unserialize() function 'api_output' => 'serialize',
// ID of the contact you wish to fetch 'id' => 1, );
// This section takes the input fields and converts them to the proper format $query = ""; foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&'; $query = rtrim($query, '& ');
// clean up the url $url = rtrim($url, '/ ');
// This sample code uses the CURL library for php to establish a connection, // submit your request, and show (print out) the response. if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');
// If JSON is used, check if json_decode is present (PHP 5.2.0+) if ( $params['api_output'] == 'json'&& !function_exists('json_decode') ) { die('JSON not supported. (introduced in PHP 5.2.0)'); }
// define a final API request - GET $api = $url . '/admin/api.php?' . $query;
$request = curl_init($api); // initiate curl object curl_setopt($request, CURLOPT_HTTPHEADER, array('API-TOKEN: ' . $api_key)); // Provide the API Token via the API-TOKEN header curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1) //curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);
$response = (string)curl_exec($request); // execute curl fetch and store results in $response
// additional options may be required depending upon your server configuration // you can find documentation on curl options at http://www.php.net/curl_setopt curl_close($request); // close curl object
if ( !$response ) { die('Nothing was returned. Do you have a connection to Email Marketing server?'); }
// This line takes the response and breaks it into an array using: // JSON decoder //$result = json_decode($response); // unserializer $result = unserialize($response); // XML parser... // ...
// Result info that is always returned echo'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />'; echo'Message: ' . $result['result_message'] . '<br />';
// The entire result printed out echo'The entire result printed out:<br />'; echo'<pre>'; print_r($result); echo'</pre>';
// Raw response printed out echo'Raw response printed out:<br />'; echo'<pre>'; print_r($response); echo'</pre>';
// API URL that returned the result echo'API URL that returned the result:<br />'; echo $api;?>