Returns a page of mailings in the account that match the given creator name

Attributes

Parameter Default Description
creatorName This is the (part of) the creator name
creatorNameOp This is the string operator for the creator name. Valid are: contains, equals, starts_with, ends_with
fields This list contains the fields that shall be returned with the result. If this list is empty, only the IDs will be returned. Valid fields are: state, type, name, and scheduleTime
page_size 100 The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.
page_index 1 The index of the result page. The index must be greater or equal to 1.
orderBy id This field can be used to change the order field. Allowed values are: is, state, name, and schedule_time.
order ASC This field sets the order direction, by default this is set to an ascending order.

Example

GET https://api.maileon.com/1.0/mailings/filter/creatorname?page_index=1&page_size=2&fields=state&fields=type&fields=name&fields=scheduleTime&creatorName=xqUser&creatorNameOp=contains
Content-type: application/vnd.maileon.api+xml
Accept: application/vnd.maileon.api+xml; charset=utf-8
Authorization: [XXX]

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: <https://api.maileon.com/1.0/mailings/filter/creatorname?page_index=1&page_size=2&fields=state&fields=type&fields=name&fields=scheduleTime&creatorName=xqUser&creatorNameOp=contains>; rel="start"
X-Items: 8
X-Pages: 4

<?xml version="1.0" encoding="UTF-8"?>
<mailings>
  <mailing>
    <id>4</id>
    <fields>
      <field>
        <name>name</name>
        <value>DOI Entwurf</value>
      </field>
      <field>
        <name>state</name>
        <value>released</value>
      </field>
      <field>
        <name>type</name>
        <value>doi</value>
      </field>
      <field>
        <name>scheduleTime</name>
        <value nil="true"/>
      </field>
    </fields>
  </mailing>
  <mailing>
    <id>5</id>
    <fields>
      <field>
        <name>name</name>
        <value>Trigger Entwurf... Geburtstag</value>
      </field>
      <field>
        <name>state</name>
        <value>released</value>
      </field>
      <field>
        <name>type</name>
        <value>trigger</value>
      </field>
      <field>
        <name>scheduleTime</name>
        <value nil="true"/>
      </field>
    </fields>
  </mailing>
</mailings>