POST GET emails/lookup

Get full details for emails, including high-level deliverability metrics (for sent emails)

* required


Name Type Description
emailID integer Unique ID of an email
emailIDs array[integer] Multiple emailIDs. Requests that use this parameter will change the response data from a single object to an array of objects.

Response Data

Returns a fully populated email object, or an array of email objects if looking up multiple emailIDs
Name Type Description
abSplit object A/B split details
abSplitID integer ID of A/B split
parentEmailID integer ID of parent email
testEmailIDs array[integer] IDs of test emails
winnerEmailID integer ID of winner email
approval object
approvalsCurrent integer Number of users who have approved email
approvalsNeeded integer Number of users who must approve email
approved boolean Overall approved status
requiresApproval boolean Indicates if email requires approval (can vary based on user and template settings)
users array Array of objects containing approval data per user
automation object Automation settings. Automated emails cannot be managed via the API.
active boolean Is automation active?
recipientDelay integer Delay (in minutes) before contacts will receive email
schedule array Array of objects with daily schedule details. e.g. [{"dayOfWeek":1,"scheduledSendTime": "07:00:00"},{"dayOfWeek":2,"scheduledSendTime": "07:00:00"},etc...]
bccAddress string Email address that will receive a BCC (blind carbon copy) for every recipient.
content object
body_slot1...body_slot10 string Content for email template slots (1 to 10)
htmlHead string Markup that will be placed in the <head> of the HTML version. Only applies to emails using a template that has the htmlHeadEditable property set to true.
htmlVersion string HTML version of email. Auto-generated by default using template in conjunction with body_slot* and htmlHead properties. If htmlVersionEditable==true, user can manually set (no template is used)
textVersion string Text version of email. Auto-generated by default, but can be manually set
dateAdded datetime Date record was added
dateModified datetime Date record was modified
dateSent datetime Date email was sent
deliveryType string How email gets delivered. One of: Manual, Automated, Transactional
emailID integer Unique ID of email
fromAddress string Email address used in From header
fromName string Name used in From header
htmlVersionEditable boolean If true, no template is used and user provides the full HTML version of email (see htmlVersion property). The HTML Version must contain the unsubscribe link variable: $$url[unsubscribe]. The value of htmlVersionEditable cannot be changed on an existing email.
ignoreContactSuppression boolean Indicates whether or not suppressed contacts can receive the email. Applies to transactional emails only.
metrics object Summary deliverability metrics
bounces integer Total number of bounces
clickToViewRate decimal Percentage of unique contacts who viewed the email and also clicked (unique views / unique clicks)
clicks integer Total number of clicks
complaints integer Total number of spam complaints
forwards integer Total number of forwards (forward-to-friend)
recipients integer Total email recipients
sendingIssues integer Total number of sending issues
shares integer Total number of shares
uniqueClicks integer Unique contacts that clicked a link
uniqueForwards integer Unique contacts that forwarded email
uniqueShares integer Unique contacts that shared email
uniqueViews integer Unique contacts that viewed email
uniqueWebViews integer Unique contacts that viewed as a web page
unsubscribes integer Total number of unsubscribes
views integer Total number of views
webViews integer Total number of web views
parentEmailID integer ID of parent email record
preheader string Summary text that follows subject line in the inbox
recipients object
contactIDs array[integer] Individual contacts assigned to receive the email. For larger sends, add the contacts to a group and send to the group.
excludeGroupIDs array[integer] Exclude contacts in these groups from receiving the email
groupIDs array[integer] Groups assigned to receive the email
replyToAddress string Email address used in Reply-to header
replyToName string Name used in Reply-to header
schedule object
confirmed boolean Is schedule delivery confirmed?
dateScheduled datetime Date/time of scheduled delivery
status string Current status of email delivery. One of: Draft, Sent, Scheduled
subject string Subject of email
templateID integer ID of template used by email. Set htmlVersionEditable property to true to provide full HTML Version without using a template
throttling object Throttling settings
minimumDeliveryDuration integer Number of hours delivery is throttled. 0 means no custom throttling. Only applies to emails with manual delivery type.
title string Title of email (for internal use)
tracking object Tracking options
clicksEnabled boolean Track which links were clicked and who did the clicking
viewsEnabled boolean Embed an invisible image in email that tracks who viewed
userID integer ID of system user email belongs to

Example Calls

Lookup email

Response Data

Lookup multiple emails by array of emailIDs

Response Data

API Console

The console uses production data, so BE CAREFUL!
Param Value Type Description
emailID integer Unique ID of an email
emailIDs array[integer] Multiple emailIDs. Requests that use this parameter will change the response data from a single object to an array of objects.
Access token: *