{"_id":"57028f6dadbd340e00928bd7","__v":0,"project":"55843604fd8d910d007b9502","editedParams":true,"editedParams2":true,"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":15,"slug":"mailing-lists","title":"Insights Platform Contacts"},"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":45,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"parentDoc":null,"user":"558435c2fb52ee0d0015d190","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:59:41.334Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"id\": \"MLRP_123456677AbCdE\",\n        \"firstName\": \"Luke\",\n        \"lastName\": \"Skywalker\",\n        \"email\": \"jediintraining:::at:::dagobah.com\",\n        \"externalDataReference\": null,\n        \"unsubscribed\": false,\n        \"embeddedData\": [],\n        \"language\": null,\n        \"recipientResponseHistory\": [\n          {\n            \"responseId\": \"R_1234567890AbCdE\",\n            \"surveyId\": \"SV_1234567890AbCdE\",\n            \"date\": \"2016-01-07T13:57:39Z\",\n            \"emailDistributionId\": \"EMD_1234567890AbCdE\",\n            \"finishedSurvey\": true\n          }\n        ],\n        \"recipientEmailHistory\": [\n          {\n            \"emailDistributionId\": \"EMD_1234567890AbCde\",\n            \"date\": \"2016-01-07T13:56:37Z\",\n            \"type\": \"Invite\",\n            \"result\": \"Success\",\n            \"surveyId\": \"SV_1234567890AbCdE\",\n            \"read\": true\n          }\n        ]\n      }\n    ],\n    \"nextPage\": null\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -H 'X-API-TOKEN: yourtokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/ML_1234567890AbCdE/samples/PL_123456890AbCdE'"}]},"method":"get","auth":"required","params":[{"_id":"55d38d150168850d0073f28d","ref":"","in":"path","required":true,"desc":"Mailing List ID","default":"","type":"string","name":"mailingListId"},{"_id":"55d38ed10168850d0073f29c","ref":"","in":"path","required":true,"desc":"Sample ID","default":"","type":"string","name":"sampleId"}],"url":"/v:version/mailinglists/:mailingListId/samples/:sampleId"},"isReference":false,"order":14,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This API call is not supported for Target Audience contacts.\"\n}\n[/block]","excerpt":"Get a mailing list sample","slug":"get-sample","type":"endpoint","title":"Get Sample"}

getGet Sample

Get a mailing list sample

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

mailingListId:
required
string
Mailing List ID
sampleId:
required
string
Sample ID

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 }}