GET /marketing-emails/v1/emails

Method Details

The results can be filtered, allowing you to find a specific set of emails you're searching for. See the table below for a full list of filtering options.

Required Parameters

How to use

Description

OAuth Access Token or API Key

Authorization: Bearer {token} headeror hapikey={key} query parameter.

Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters

How to use

Description

Limit

&limit=Used in the request URL

The number of records to return in the response. Defaults to 10

Offset

&offset=Used in the request URL

Used to get the next page of results. Use the limit of the previous request as the offset to get the next set of results.

Order by

&orderBy=Used in the request URL

Return the emails ordered by a particular field value. Use a negative value to sort in descending order (e.g. orderBy=-created).

Filtering

Results can be filtered based on specific fields. You can filter for a field by including it as a query parameter. For example, you can filter by campaign by including &campaign=:campaign_id in the request URL.

In addition to filtering for an exact match, some fields support other filter types, designated by including two underscores between the field name and the type. For example, you can filter for emails created after December 31, 2018, by including &created__gt=1546318800000 in the request URL.

The list of fields that support filtering, and the supported filter types for those fields are listed below.

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...