View many (or all) contact organizations by including their ID's or various filters. This is useful for searching for contact organizations that match certain criteria.
Endpoint:
/admin/api.php?api_action=customer_account_list
HTTP method:
GET
Supported output formats:
json
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*
organization_list
api_output
json
filters
See below code example for all filters you can pass.
full
Whether or not to return ALL data, or an abbreviated portion (set to 1 for ALL data, and 0 for abbreviated).
sort
Field to sort on (possible values: id, datetime).
sort_direction
Direction of sort (possible values: ASC or DESC).
page
Pagination: results are limited to 20 per page, so specify what page to view.
Example response:
Variable
Description
0
Array
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: json
PHP Example
This is an example of using the customer_account_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
// 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';
// optional custom field search: provide field ID, and search query (this searches all custom field values)
/*
$fields = array(
1 => 'value', // in this case, 1 is the custom field ID, and 'value' is the value you are searching for
);
*/
// 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(
'api_action' => 'customer_account_list',
// define the type of output you wish to get back
// possible values:
// - 'json' : data is returned in JSON format and can be decoded with
// json_decode() function (included in PHP since 5.2.0)
'api_output' => 'json',
// filters (optional): supply filters that will narrow down the results
// Title: exact match
//'filters[name]' => 'Acme Corporation',
// 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, datetime, first_name, last_name
//'sort_direction' => 'DESC', // ASC or DESC
//'page' => 2, // pagination - results are limited to 20 per page, so specify what page to view (default is 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, true);
// 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';
// optional custom field search: provide field ID, and search query (this searches all custom field values) /* $fields = array( 1 => 'value', // in this case, 1 is the custom field ID, and 'value' is the value you are searching for ); */
// 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(
'api_action' => 'customer_account_list',
// define the type of output you wish to get back // possible values: // - 'json' : data is returned in JSON format and can be decoded with // json_decode() function (included in PHP since 5.2.0) 'api_output' => 'json',
// filters (optional): supply filters that will narrow down the results
// Title: exact match //'filters[name]' => 'Acme Corporation',
// 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, datetime, first_name, last_name //'sort_direction' => 'DESC', // ASC or DESC //'page' => 2, // pagination - results are limited to 20 per page, so specify what page to view (default is 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, true);
// 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;?>
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
Manage Consent Preferences
Performance Cookies
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
Functional Cookies
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
Strictly Necessary Cookies
Always Active
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.
Targeting Cookies
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising.