The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options.
Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
Specifies whether to return archived emails. Defaults to false.
Filter by campaign GUID. All emails will be returned if not present.
Only return emails created after the specified time.
Only return emails created at exactly the specified time.
Only return emails created before the specified time.
Limit the response to only include this specified list of properties.
Include statistics with emails.
Filter by published/draft emails. All emails will be returned if not present.
The maximum number of results to return. Default is 10.
Include the names for any associated marketing campaigns.
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
Email types to be filtered by. Multiple types can be included. All emails will be returned if not present.
AB_EMAIL, AUTOMATED_AB_EMAIL, AUTOMATED_EMAIL, BATCH_EMAIL, BLOG_EMAIL, BLOG_EMAIL_CHILD, FEEDBACK_CES_EMAIL, FEEDBACK_CUSTOM_EMAIL, FEEDBACK_CUSTOM_SURVEY_EMAIL, FEEDBACK_NPS_EMAIL, FOLLOWUP_EMAIL, LEADFLOW_EMAIL, LOCALTIME_EMAIL, MARKETING_SINGLE_SEND_API, MEMBERSHIP_EMAIL_VERIFICATION_EMAIL, MEMBERSHIP_FOLLOW_UP_EMAIL, MEMBERSHIP_OTP_LOGIN_EMAIL, MEMBERSHIP_PASSWORD_RESET_EMAIL, MEMBERSHIP_PASSWORD_SAVED_EMAIL, MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL, MEMBERSHIP_REGISTRATION_EMAIL, MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL, MEMBERSHIP_VERIFICATION_EMAIL, OPTIN_EMAIL, OPTIN_FOLLOWUP_EMAIL, RESUBSCRIBE_EMAIL, RSS_EMAIL, RSS_EMAIL_CHILD, SINGLE_SEND_API, SMTP_TOKEN, TICKET_EMAIL Only return emails last updated after the specified time.
Only return emails last updated at exactly the specified time.
Only return emails last updated before the specified time.
Include the names of any workflows associated with the returned emails.