POST GET emailReports/recipients

Get recipients for a given email

* required

Parameters

Name Type Description
emailID * integer ID of email
viewed boolean Filter by contacts who viewed
clicked boolean Filter by contacts who clicked a link
bounced boolean Filter by contacts who bounced
bounceType string Filter by bounce type. SB (soft bounce) returns all bounce types except HB (hard bounce)
HB, SB
suppressed boolean Filter by contacts who opted out
complained boolean Filter by contacts who complained
contactFields string Comma-separated list of contact fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes
contactID, email, firstName, lastName
page integer Number of page in results to return
1
1
rpp integer Number of records to return per page
20
1
1000

Response Data

Name Type Description
contactID integer ID of contact
email string
firstName string
lastName string
viewed boolean Contact viewed email
clicked boolean Contact clicked a link
bounced boolean Contact email bounced
bounceType string Code for type of bounce
complained boolean Contact complained
suppressed boolean Contact opted out
emailID integer Unique ID of email
parentEmailID integer ID of parent email record

Example Calls

Get all recipients

GET
/emailReports/recipients
cURL
Copy
Response Data

Specify contact fields

You can specify which contact fields you want returned. ContactID is always returned, along with all recipient-specific data (viewed, clicked, etc...)

GET
/emailReports/recipients?contactFields=email,custom1
cURL
Copy
Response Data

Get recipients that viewed

GET
/emailReports/recipients?viewed=1
cURL
Copy

API Console

The console uses production data, so BE CAREFUL!
GET
emailReports/recipients
Param Value Type Description
emailID * integer ID of email
viewed boolean Filter by contacts who viewed
clicked boolean Filter by contacts who clicked a link
bounced boolean Filter by contacts who bounced
bounceType string Filter by bounce type. SB (soft bounce) returns all bounce types except HB (hard bounce)
HB, SB
suppressed boolean Filter by contacts who opted out
complained boolean Filter by contacts who complained
contactFields string Comma-separated list of contact fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes
contactID, email, firstName, lastName
page integer Number of page in results to return
1
1
rpp integer Number of records to return per page
20
1
1000
Access token: *