Skip to navigation
API ReferenceReports

Get campaign recipient info

Get information about a specific campaign recipient.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

campaign_idstringRequired
The unique id for the campaign.
subscriber_hashstringRequired
The MD5 hash of the lowercase version of the list member's email address.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

This endpoint returns an object.
absplit_groupenumOptional

For A/B Split Campaigns, the group the member was apart of.

Allowed values:
campaign_idstringOptionalRead-only
The campaign id.
email_addressstringOptionalRead-only
Email address for a subscriber.
email_idstringOptionalRead-only
The MD5 hash of the lowercase version of the list member's email address.
gmt_offsetintegerOptional
For campaigns sent with timewarp, the time zone group the member is apart of.
last_opendatetimeOptional
The date and time of the last open for this member in ISO 8601 format.
list_idstringOptionalRead-only
The unique list id.
list_is_activebooleanOptionalRead-only
The status of the list used, namely if it's deleted or disabled.
merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

open_countintegerOptional
The number of times a campaign was opened by this member.
statusenumOptional

The status of the email delivered to this subscriber. hard and soft refer to different bounce types.

Allowed values:
vipbooleanOptionalRead-only

VIP status for subscriber.