{"_id":"5702905c747d6d0e0076ff79","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":55,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"__v":1,"category":{"_id":"55ad4d1933616a0d00599d2f","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","pages":["55ad4fa424cf160d00135866","55ad4fb46aadf20d0015b77c","55ad4fc724cf160d00135868","55ad4fdb24cf160d0013586a","55ad4ff424cf160d0013586c","55ad500824cf160d0013586e","55ad50206aadf20d0015b77e","55ad503a6aadf20d0015b780","5633d0277b56ae0d0025a057","56e333d0941515170011da12"],"__v":10,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-20T19:33:45.600Z","from_sync":false,"order":17,"slug":"mailing-lists","title":"Insights Platform Contacts"},"parentDoc":null,"user":"558435c2fb52ee0d0015d190","editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T16:03:40.369Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"id\": \"MLRP_1234567890aaaaa\",\n        \"firstName\": \"John\",\n        \"lastName\": \"Doe\",\n        \"email\": \"John_Doe:::at:::email.com\",\n        \"externalDataReference\": null,\n        \"embeddedData\": {\n          \"custom\": \"Mathematics\",\n          \"EmbeddedDataB\": \"\"\n        },\n        \"language\": null,\n        \"unsubscribed\": false,\n        \"responseHistory\": [\n          {\n            \"responseId\": \"R_1234567890abcde\",\n            \"surveyId\": \"SV_1234567890abcde\",\n            \"date\": \"2015-04-09T13:42:51Z\",\n            \"emailDistributionId\": \"EMD_1234567890abcde\",\n            \"finishedSurvey\": true\n          }\n        ],\n        \"emailHistory\": [\n          {\n            \"emailDistributionId\": \"EMD_1234567890abcde\",\n            \"date\": \"2015-04-09T19:42:29Z\",\n            \"type\": \"Invite\",\n            \"result\": \"Success\",\n            \"surveyId\": \"SV_1234567890abcde\",\n            \"read\": true\n          }\n        ]\n      },\n      {\n        \"id\": \"MLRP_0000000009bbbbb\",\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\",\n        \"email\": \"Jane_Doe@email.com\",\n        \"externalDataReference\": null,\n        \"embeddedData\": [],\n        \"language\": null,\n        \"unsubscribed\": false,\n        \"responseHistory\": [],\n        \"emailHistory\": []\n      },\n      ...\n    ],\n    \"nextPage\": \"https://yourdatacenter.qualtrics.com/API/v3/mailinglists/ML_1234567890abcde/contacts?skipToken=MLRP_1234567890eeeee\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","name":""}]},"settings":"","examples":{"codes":[{"name":"","code":"curl -H 'X-API-TOKEN: yourtokenhere' 'http://yourdatacenterid.qualtrics.com/API/v3/mailinglists/ML_1234567890AbCdE/contacts'","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"55ad70ea33616a0d00599dfe","ref":"","in":"path","required":true,"desc":"ID of the mailing list from which to get the contacts (found [in Qualtrics IDs](#finding-qualtrics-ids))","default":"","type":"string","name":"mailingListId"},{"_id":"595fb2f75c5582001bb74f36","ref":"","in":"query","required":false,"desc":"Returns next 100 contacts after specified RecipientID. If there are additional pages, the skipToken value for the next page will be appended to the value of the nextPage parameter in the response.","default":"","type":"string","name":"skipToken"}],"url":"/v:version/mailinglists/:mailingListId/contacts"},"isReference":false,"order":6,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This API call is not supported for Target Audience contacts.\"\n}\n[/block]","excerpt":"Retrieves members of the mailing list","slug":"list-contacts","type":"endpoint","title":"List Contacts"}

getList Contacts

Retrieves members of the mailing list

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

mailingListId:
required
string
ID of the mailing list from which to get the contacts (found [in Qualtrics IDs](#finding-qualtrics-ids))

Query Params

skipToken:
string
Returns next 100 contacts after specified RecipientID. If there are additional pages, the skipToken value for the next page will be appended to the value of the nextPage parameter in the response.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "This API call is not supported for Target Audience contacts." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}