Email Marketing API - List Retrieval

listGet

public static array listGet(string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)

Get the contact lists in your account.

Section

Contact List Related Methods

Parameters
string token	A valid token for your account. To generate a token, use the login method.
string filter	Show lists where the contact list name starts with the filter
integer pageNumber	Fetch results from the given page number.
integer pageSize	Number of results per page.
string orderBy	Sort the results based on "name" or "date".
string sortOrder	Sort the results in the "asc"ending or "desc"ending order.

Returns
array	Returns an array with the results.

Return Structure
integer sequence	The sequence number of the record
string id	The ID of the contact list. To get the contacts from this list , use the listGetContacts method.
string listname	Name of the contact list
integer contactcount	The number of active contacts in the list
string createdDate	The date on which the list was created
string modifiedDate	The date on which the list was last updated

Examples
download example code
xmlrpc_listGet.php

<?php
/**
This Example shows how to authenticate a user using XML-RPC.
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.php';
$client = XML_RPC2_Client::create($apiURL);
$token = $client->login($apiLogin, $apiPassword);
$contactLists = $client->listGet($token, "", 1, 100, "", "");
foreach($contactLists as $rec) {
echo $rec['sequence'] . "] List Name: " . $rec['listname'] . "(" . $rec['id'] . ")";
echo "\t Contacts:" . $rec['contactcount'] . "\t Created Date: " . $rec['createdDate'] ;
echo "\t Updated Date: " . $rec['modifiedDate'];
echo "<br />";
}
?>