Get all contacts that match the filter with the ID
1 |
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. | |
custom_field | Multivalued parameter to query the value of a custom contact field. | |
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"/> <standard_fields> <field> <name>FIRSTNAME</name> <value nil="true"/> </field> </standard_fields> <custom_fields/> </contact> </contacts>