GetList

Retrieves the list of campaigns. Parameters:

user_key - the user's key

Optional parameters:

status - it can be:
- ongoing
- closed
- deleted
limit - this limits the maximum of returned campaigns
offset - used together with limit; the list is retrieved from this offset
count - used to count the campaigns

Returns for every matching template:

id
client_id
status
name
created_on
closed_on

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

count

XML request (without count):

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

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassCampaign" locale="en_US">
    <method type="GetList">
      <campaign>
        <id>4</id>
        <client_id>5</client_id>
        <status>ongoing</status>
        <name>Denis%20Testing%203</name>
        <created_on>2007-03-14%2010%3A51%3A05</created_on>
        <closed_on>0000-00-00%2000%3A00%3A00</closed_on>
      </campaign>
      <campaign>
        <id>5</id>
        <client_id>5</client_id>
        <status>ongoing</status>
        <name>Denis%20testing%202</name>
        <created_on>2007-03-20%2005%3A30%3A37</created_on>
        <closed_on>0000-00-00%2000%3A00%3A00</closed_on>
      </campaign>
    </method>
  </class>
</result>

XML request (with count):

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

XML response (with count):

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