Developers

<?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 campaign info based on the ID you provide
	'api_action'   					=> 'campaign_list',

	// 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',

	// a comma-separated list of IDs of campaigns you wish to fetch
	'ids'          					=> '1,2,3,4,5',

	// filters: supply filters that will narrow down the results

	// Campaign ID: only include campaigns with an ID greater than some integer
	// 'filters[id_greater]' 			=> '44',

	// Campaign ID: only include campaigns with an ID less than some integer
	// 'filters[id_less]'       		=> '44',

	// perform a pattern match (LIKE) for Campaign Name
	// 'filters[name]'          		=> 'General',

	// campaign type
	// 'filters[type]'          		=> 'single',
	// possible values:
	// - 'single'
	// - 'recurring'
	// - 'split'
	// - 'responder'
	// - 'reminder'
	// - 'activerss'
	// - 'text'

	// Campaigns sent to certain lists: exact match - provide single list ID, or comma-separated list ID's
	// 'filters[listid]'        		=> '4',

	// Campaigns created *since* a specified date in the past: exact match - provide MySQL-formatted date/time string
	// 'filters[cdate_since_datetime]'	=> '2009-10-22 00:00:00',

	// Campaigns that started sending *since* a specified date in the past: exact match - provide MySQL-formatted
	// date/time string
	// 'filters[sdate_since_datetime]' 	=> '2009-10-22 00:00:00',

	// Campaigns that last sent *since* a specified date in the past: exact match - provide MySQL-formatted date/time
	// string
	// 'filters[ldate_since_datetime]' 	=> '2009-10-22 00:00:00',

	// Campaigns created by users of specific group(s). Please note your API user must be in the "Admin" Group to
	// retrieve different group data
	// 'filters[groupids]' 				=> '5,7,9',

	// whether or not to return ALL data, or an abbreviated portion (set to 0 for abbreviated)
	'full'         					=> 1,

	// optional: change how results are sorted (default is below)
	// 'sort'                   		=> 'id'
	// possible values:
	// - 'id' (campaign id)
	// - 'cdate'

	// 'sort_direction'         		=> 'DESC'
	// possible values:
	// - 'ASC'
	// - 'DESC'

	// pagination - results are limited to 10 per page, so specify what page to view (default is 1)
	// 'page'							=> 2,
);

// 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;?>