Create a free account

API Documentation

Campaign Monitor

API documentation > Client.GetLists

Client.GetLists

Gets a list of all subscriber lists for a client.

Samples

While we don't have any samples for this particular method, we do have a number of samples in .NET, PHP, Classic ASP, Flash, Perl and Cold Fusion that can be easily adapted to use this method.

Parameters and required information

Here's a list of all the parameters you'll need to pass to the Client.GetLists method. All of the parameters are required unless otherwise noted.

ApiKey
Your API application key. See here for more details.
ClientID
The ID of the client whose subscriber lists should be returned. See here for more details.

Return Codes

Success

Upon a successful call, this method will return a collection of List objects, each of which consists of a ListID, and the name of the list.

Error

100: Invalid API Key
The API key passed was not valid or has expired.
102: Invalid ClientID
The ClientID value passed in was not valid.

SOAP 1.1

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: app.campaignmonitor.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://app.campaignmonitor.com/api/Client.GetLists"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Client.GetLists xmlns="http://app.campaignmonitor.com/api/">
      <ApiKey>string</ApiKey>

      <ClientID>int</ClientID>
    </Client.GetLists>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Client.GetListsResponse xmlns="http://app.campaignmonitor.com/api/">

      <Client.GetListsResult>
        <List>
          <ListID>int</ListID>
          <Name>string</Name>
        </List>

        <List>
          <ListID>int</ListID>
          <Name>string</Name>
        </List>
      </Client.GetListsResult>

    </Client.GetListsResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/api.asmx/Client.GetLists?ApiKey=string&ClientID=string HTTP/1.1
Host: app.campaignmonitor.com


HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfList xmlns="http://app.campaignmonitor.com/api/">

  <List>
    <ListID>int</ListID>
    <Name>string</Name>
  </List>
  <List>

    <ListID>int</ListID>
    <Name>string</Name>
  </List>
</ArrayOfList>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx/Client.GetLists HTTP/1.1
Host: app.campaignmonitor.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ClientID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfList xmlns="http://app.campaignmonitor.com/api/">
  <List>
    <ListID>int</ListID>
    <Name>string</Name>

  </List>
  <List>
    <ListID>int</ListID>
    <Name>string</Name>
  </List>

</ArrayOfList>