POST GET contacts/getEmailHistory
Get emails sent to a single contact. ContactID or email is required.
* required
Parameters
| Name | Type | Description |
|---|---|---|
| contactID | integer | Unique ID of a contact |
| email-address | An email address of an existing contact | |
| dateSentStart | datetime | Emails sent since this date. |
| dateSentEnd | datetime | Emails sent before this date. |
| viewed | boolean | |
| clicked | boolean | |
| suppressed | boolean | |
| complained | boolean | |
| page | integer |
Number of page in results to return
1
1
|
| rpp | integer |
Number of records to return per page
20
1
250
|
| sortField | string |
The field to sort results by
dateSent
dateSent
|
| sortDirection | string |
The direction to sort results
desc
asc, desc
|
Response Data
| Name | Type | Description |
|---|---|---|
| emailID | integer | ID of email |
| subject | string | Subject of email |
| dateSent | datetime | Date email was sent |
| viewed | boolean | Did contact view email? |
| clicked | boolean | Did contact click a link? |
| suppressed | boolean | Did contact opt out? |
| complained | boolean | Did contact register a spam complaint? |
| bounced | boolean | Did email bounce? |
| bounceType | string | Email bounce code |
| bounceDescription | string | Description of email bounce code |
Example Calls
GET
/contacts/getEmailHistory?contactID=123
cURL
Copy
Response Data
API Console
The console uses production data, so BE CAREFUL!
GET
contacts/getEmailHistory