GetList

Returns the list of mailings. Parameters:

user_key
mailing_id

Search criteria:

status
campaign_id
list_id

Optional parameters:

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

Returns for each matching mailing:

id
campaign_id
list_id
sublist_id
active_emails
status
next_step
suspended
created_on
scheduled_on
scheduled_for
name
subject

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="ClassMailing" locale="en_US">
    <method type="GetList">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <campaign_id>42</campaign_id>
    </method>
  </class>
</body>

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassMailing" locale="en_US">
    <method type="GetList">
      <mailing>
        <id>117</id>
        <campaign_id>42</campaign_id>
        <list_id>109</list_id>
        <sublist_id>0</sublist_id>
        <active_emails>116</active_emails>
        <status>delivered</status>
        <next_step>stats</next_step>
        <suspended>false</suspended>
        <created_on>2007-07-03%2015%3A13%3A08</created_on>
        <scheduled_on>2007-07-04%2009%3A24%3A07</scheduled_on>
        <scheduled_for>2007-07-04%2009%3A24%3A07</scheduled_for>
        <name>test%20mailing</name>
        <subject>Test%20subject</subject>
      </mailing>
      <mailing>
        <id>289</id>
        <campaign_id>42</campaign_id>
        <list_id>248</list_id>
        <sublist_id>0</sublist_id>
        <active_emails>30</active_emails>
        <status>delivered</status>
        <next_step>stats</next_step>
        <suspended>false</suspended>
        <created_on>2007-07-20%2010%3A01%3A55</created_on>
        <scheduled_on>2007-07-20%2010%3A16%3A10</scheduled_on>
        <scheduled_for>2007-07-20%2010%3A16%3A10</scheduled_for>
        <name>test%20mailing2</name>
        <subject>Test%20subject2</subject>
      </mailing>
    </method>
  </class>
</result>

XML request (with count):

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

XML response (with count):

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