This method returns a page of contacts that received at least one mailing. The results can be filtered by one or more mailings and/or the time interval to get specific contacts e.g. for a given campaign.

Attributes

Parameter Default Description
from_date   If provided, only the recipients after or equal (including) the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00
to_date   If provided, only the recipients before (excluding) the given date will be returned. This can be used e.g. for trigger mailings. The value of to_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00
mailing_id   Multivalued parameter to filter the recipients by mailings. Each value must correspond to a mailing id.
ids Multivalued parameter to filter the results by contacts. Each value must correspond to a contact id.
emails Multivalued parameter to filter the results by email addresses.
eids Multivalued parameter to filter the results by external ids. Each value must correspond to a contacts external id
exclude_deleted_recipients false Supported values: true / false. If set to true, the recipients that have been removed from maileon will be excluded.
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.
embed_field_backups false Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each subscriber, the corresponding field backups will be returned if available.
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.

Example