lists – v1.2

 lists(string apikey)

Retrieve all of the lists defined for your user account

Section
List Related

Parameters
apikey a valid API Key for your user account. Get by visiting your API dashboard

Returns
array	list of your Lists and their associated information (see Returned Fields for description)

Returned Fields
string	id	The list id for this list. This will be used for all other list management functions.
integer	web_id	The list id used in our web app, allows you to create a link directly to it
string	name	The name of the list.
date	date_created	The date that this list was created.
integer	member_count	The number of active members in the given list.
integer	unsubscribe_count	The number of members who have unsubscribed from the given list.
integer	cleaned_count	The number of members cleaned from the given list.
boolean	email_type_option	Whether or not the List supports multiple formats for emails or just HTML
string	default_from_name	Default From Name for campaigns using this list
string	default_from_email	Default From Email for campaigns using this list
string	default_subject	Default Subject Line for campaigns using this list
string	default_language	Default Language for this list's forms
double	list_rating	An auto-generated activity score for the list (0 - 5)
integer	member_count_since_send	The number of active members in the given list since the last campaign was sent
integer	unsubscribe_count_since_send	The number of members who have unsubscribed from the given list since the last campaign was sent
integer	cleaned_count_since_send	The number of members cleaned from the given list since the last campaign was sent

Examples (2)

download example code

[1] mcapi_lists.php

<?php
/**
This Example shows how to pull the Members of a List using the MCAPI.php 
class and do some basic error checking.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$retval = $api->lists();
 
if ($api->errorCode){
	echo "Unable to load lists()!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
	echo "Your lists:\n";
	foreach ($retval as $list){
		echo "Id = ".$list['id']." - ".$list['name']." - ".$list['web_id']."\n";
		echo "\tSub = ".$list['member_count']."\tUnsub=".$list['unsubscribe_count']."\tCleaned=".$list['cleaned_count']."\n";
	}
}
 
?>
 

[2] xml-rpc_lists.php

<?php
/**
This Example shows how to use XML-RPC to Retrieve all of the Lists on your
account and display some info about them.
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
	$lists = $client->lists($apikey);
	echo "SUCCESS!\n";
	foreach ($lists as $list){
		echo "Id = ".$list['id']." - ".$list['name']."\n";
	}
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
?>