+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.

Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS

Get Contacts By Filter Id

Sie sind hier:

Get all contacts that match the filter with the ID.

Please note: this resource does not return anonymized contacts but it removes them after assembling the pages, i.e. if the contact filter contains anonymized contacts, the pages might have missing contacts, or even 0, if there are only anonymized contacts on the first page. This behavior will be changed in a future release of Maileon.

GET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}

Attributes

Parameter Default Description
standard_field Multivalued parameter to query the value of a standard contact field. If a standard field has no value, it will be returned with nil-type value: <value nil=„true“></value>.
custom_field Multivalued parameter to query the value of a custom contact field. If no custom fields are specified, tag <custom_fields/> is returned, if a custom field has no value it will be removed from the answer.
preference_categories Multivalued parameter to query the preference values of a contact preference category. If nothing is specified the returned tag <preferences> will be ommitted.
page_index 1 The index of the result page. The index must be greater or equal to 1.
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.

The response contains a permission type, this is one of the following strings:

Value Type ID
none 1
soi 2
coi 3
doi 4
doi+ 5
other 6 
GET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}
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;charset=utf-8
Link: <https://api.maileon.com/1.0/contacts/filter/1?page_index=1&standard_field=FIRSTNAME&page_size=5>; rel="start"
X-Items: 3
X-Pages: 1

<?xml version="1.0" encoding="UTF-8"?>

<contacts>
  <contact anonymous="true">
    <id>112</id>
    <external_id>someExternalId2</external_id>
  </contact>
  <contact anonymous="true">
    <id>113</id>
    <external_id>someExternalId2</external_id>
  </contact>
  <contact>
    <id>114</id>
    <email>xq@xqueue.com</email>
    <permissionStatus>available</permissionStatus>
    <permissionType>doi+</permissionType>
    <external_id nil="true"/>
    <created>2016-06-13 09:14:41.0</created>
    <updated>2017-10-30 13:20:08.0</updated>
    <standard_fields>
      <field>
        <name>FIRSTNAME</name>
        <value nil="true"/>
      </field>
    </standard_fields>
    <custom_fields/>
  </contact>
</contacts>

Example of contact with contact preferences

<contacts>
  <contact>
    <id>12345</id>
    <email>max.mustermann@xqueue.com</email>
    <external_id>mustermann-ext-1956</external_id>
    <created>2016-06-13 09:14:41.0</created>
    <updated>2021-10-30 13:20:08.0</updated>
    <standard_fields>
      <field>
        <name>FIRSTNAME</name>
        <value>Max</value>
      </field>
      <field>
        <name>LASTNAME</name>
        <value>Mustermann</value>
      </field>
    </standard_fields>
    <custom_fields/>
    <preferences>
      <preference>
        <name>Shopware</name>
        <category>Developer</category>
        <value>true</value>
        <source nil="true"/>
        <last_modified>2021-08-19 15:30:53</last_modified>
      </preference>
      <preference>
        <name>Magento</name>
        <category>Developer</category>
        <value>false</value>
        <source nil="true"/>
        <last_modified>2021-08-19 15:30:53</last_modified>
      </preference>
    </preferences>
  </contact>
</contacts>
Inhaltsverzeichnis