ListContactsResponse

result objectrequired

elements object[]required

Array [

idContactId (string)required

Mailing List Contact ID

Example: MLRP_1234567890aaaaa

firstNameFirstName (string)nullable

First Name of the contact

lastNameLastName (string)nullable

Last Name of the contact

emailEmail (string)

Email Address of the contact.

extRefExtRef (string)nullable

External data reference

embeddedData objectnullable

Embedded data values for the contact. These are defined by you for your purposes.

property name*string

languageLanguage (string)nullable

The language code used.

unsubscribedUnsubscribed (boolean)

Indicates whether the contact unsubscribed

Default value: false

responseHistory object

responseIdResponseId (string)

The ID OF the response.

Possible values: Value must match regular expression ^R_[0-9a-zA-Z]{11,15}$

Example: R_3gFikOSvsGiEA4J

surveyIdSurveyid (string)

The ID of the survey.

Possible values: Value must match regular expression ^SV_[0-9a-zA-Z]{11,15}$

Example: SV_cHbKMOdeT8NetF3

datestring<date-time>

The date and time of the response.

emailDistributionIdDistributionId (string)

The distribution ID

Example: EMD_1234567890abcde

finishedSurveyboolean

Indicates whether the contact completed the survey.

emailHistory object

typestring

resultstring

readboolean

surveyIdSurveyid (string)

The ID of the survey.

Possible values: Value must match regular expression ^SV_[0-9a-zA-Z]{11,15}$

Example: SV_cHbKMOdeT8NetF3

datestring<date-time>

emailDistributionIdDistributionId (string)

The distribution ID

Example: EMD_1234567890abcde

]

nextPageNextPage (string)nullablerequired

meta objectrequired

requestIdRequestId (string)required

httpStatusHttpStatus (string)required

noticeAn informational string about the request. (string)

ListContactsResponse

{
  "result": {
    "elements": [
      {
        "id": "MLRP_1234567890aaaaa",
        "firstName": "John",
        "lastName": "Doe",
        "email": "John_Doe@email.com",
        "extRef": null,
        "embeddedData": {
          "custom": "Mathematics",
          "EmbeddedDataB": ""
        },
        "language": null,
        "unsubscribed": false,
        "responseHistory": {
          "responseId": "R_1234567890abcde",
          "surveyId": "SV_1234567890abcde",
          "date": "2015-04-09T13:42:51Z",
          "emailDistributionId": "EMD_1234567890abcde",
          "finishedSurvey": true
        },
        "emailHistory": {
          "emailDistributionId": "EMD_1234567890abcde",
          "date": "2015-04-09T19:42:29Z",
          "type": "Invite",
          "result": "Success",
          "surveyId": "SV_1234567890abcde",
          "read": true
        }
      }
    ],
    "nextPage": "https://yourdatacenter.qualtrics.com/API/v3/mailinglists/ML_1234567890abcde/contacts?skipToken=MLRP_1234567890eeeee"
  },
  "meta": {
    "httpStatus": "200 - OK",
    "requestId": "0c794f23-30f3-42de-b054-cc420cbac00f"
  }
}