POST GET exports/emailRecipients
Get recipient data across email campaigns. Date range cannot span more than 90 days.
* required
Parameters
| Name | Type | Description |
|---|---|---|
| startDate * | datetime | Emails sent after this date |
| endDate * | datetime | Emails sent before this date |
| fields | string |
Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, contactID, email, dateSent
id, emailID, contactID, email, dateSent
|
Response Data
| Name | Type | Description |
|---|---|---|
| jobID | integer | ID of export job. Use to check the status of the job at /exports/jobStatus |
Permissions
Method requires the Client admin permission
Example Calls
Recipients in past 30 days
GET
/exports/emailRecipients?startDate=2024-10-22&endDate=2024-11-21
cURL
Copy
Response Data
Report Columns
| Name | Type | Description |
|---|---|---|
| id | integer | Unique ID of record |
| emailID | integer | ID of email record |
| parentEmailID | integer | ID of parent email record |
| contactID | integer | ID of contact record |
| string | Email address of contact record | |
| dateSent | datetime | Date email was sent |
Sample Report
"id" "emailID" "contactID" "email" "dateSent" "5132653" "123456" "23680470" "john.doe@example.com" "2014-04-29 14:17:10.91" "5132654" "123456" "23680470" "jane.doe@example.com" "2014-04-29 14:17:16.77"
API Console
The console uses production data, so BE CAREFUL!
GET
exports/emailRecipients