Get Contact History In Mailing List

GET {{baseUrl}}/directories/:directoryId/mailinglists/:mailingListId/contacts/:contactId/history?type=response&skipToken=<string>&pageSize=100

Retrieve the history for contacts in a mailing list. <!--From Readme--> For the last page of results, the value associated with nextPage will be null. <!-- theme: warning -->

This API call is only available to XM Directory users.

Request Params

KeyDatatypeRequiredDescription
typestring(Required) The desired history type; one of two values: email and response
skipTokenstringThe start position for pagination
pageSizenumberThe maximum number of items to return per request

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;elements&quot;:[{&quot;distributionId&quot;:&quot;\u003cstring\u003e&quot;,&quot;date&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;result&quot;:&quot;Failure&quot;,&quot;bounceInfo&quot;:{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;statusCode&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;blacklisted&quot;:&quot;\u003cboolean\u003e&quot;},&quot;surveyId&quot;:&quot;\u003cstring\u003e&quot;,&quot;read&quot;:&quot;\u003cboolean\u003e&quot;,&quot;lookupId&quot;:&quot;\u003cstring\u003e&quot;,&quot;responseId&quot;:&quot;\u003cstring\u003e&quot;,&quot;surveyStartedDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;surveyCompletedDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;surveyFinished&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;distributionId&quot;:&quot;\u003cstring\u003e&quot;,&quot;date&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;result&quot;:&quot;Unknown&quot;,&quot;bounceInfo&quot;:{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;statusCode&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;blacklisted&quot;:&quot;\u003cboolean\u003e&quot;},&quot;surveyId&quot;:&quot;\u003cstring\u003e&quot;,&quot;read&quot;:&quot;\u003cboolean\u003e&quot;,&quot;lookupId&quot;:&quot;\u003cstring\u003e&quot;,&quot;responseId&quot;:&quot;\u003cstring\u003e&quot;,&quot;surveyStartedDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;surveyCompletedDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;surveyFinished&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;nextPage&quot;:&quot;\u003cstring\u003e&quot;},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}