GetList

Retrieves the list of lists. Parameters:

user_key

Search criteria:

status

Optional parameters:

limit - this limits the maximum of returned lists
offset - used together with limit; the list is retrieved from this offset
count - used to count the lists

Returns:

id
name
status
language
created_on
created_name
created_email

When count is used, it returns the count of the matching lists. This is helpful when the lists are shown on multiple pages.

count

XML request (without count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassList" locale="en_US">
    <method type="GetList">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <limit>2</limit>
      <offset>1</offset>
    </method>
  </class>
</body>

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassList" locale="en_US">
    <method type="GetList">
      <list>
        <id>126</id>
        <name>g_opt-in</name>
        <status>active</status>
        <language>en_US</language>
        <created_on>2007-06-19%2011%3A31%3A44</created_on>
        <sender_name></sender_name>
        <sender_email></sender_email>
      </list>
      <list>
        <id>129</id>
        <name>test</name>
        <status>active</status>
        <language>en_US</language>
        <created_on>2007-06-20%2015%3A55%3A14</created_on>
        <sender_name>John%20Doe</sender_name>
        <sender_email>john%40doe.com</sender_email>
      </list>
    </method>
  </class>
</result>

XML request (with count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassList" locale="en_US">
    <method type="GetList">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <count>true</count>
    </method>
  </class>
</body>

XML response (with count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassList" locale="en_US">
    <method type="GetList">
      <count>14</count>
    </method>
  </class>
</result>