List Emails
Returns emails belonging to the tenant. When called without a campaignid the response includes emails of every status across every campaign (useful for building a tenant-wide email inventory). When a campaignid is provided the response is filtered to Active emails in that campaign only.
Path Parameters
campaignidnumber
Optional campaign id. When provided, only Active emails in this campaign are returned. When omitted, all emails for the tenant are returned regardless of status.
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"emails": [
{
"emailId": 93,
"name": "An example email",
"campaignId": 144,
"status": "Active",
"from": "hello@example.com",
"subject": "This is an example email",
"date_last_modified": "2021-11-20T22:37:12.82",
"total_sent": 1409,
"total_opened": 4,
"total_clicked": 1
}
]
}
}
HTTP Response Parameters
emailsarray
Array of Email objects. See Get Email for the shape of each item.