Returns a page of contacts that subscribed for the given account. The contacts can be filtered either by a date interval or one or a list of mailing IDs (DOI Mailings). Note that this only returns subscribers that were subscribed by a DOI mailing that was sent through Maileon.

Attributes

ParameterDefaultDescription
from_date If provided, only the new subscribers having acknowledged a DOI confirmation link 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 new subscribers having acknowledged a DOI confirmation link before (excluding) the given date will be returned. 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 subscribers by (DOI) 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_anonymous_contactstrueSupported values: true / false. If set to true, the subscribers that cannot be mapped to contacts because of permission types or because of unsubscription are omitted in the results.
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_index1The index of the result page. The index must be greater or equal to 1.
page_size100The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Example

The response may contain the attribute “ip” in addition if logging the IP is enabled in Maileon: Settings – Contact-Management.