{"_id":"57abb3c2b5e8742000e17ed5","user":"57ab8375f68f6e1900a8ab9c","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"},"project":"55843604fd8d910d007b9502","__v":3,"category":{"_id":"55d3c6befe37111900e536fa","pages":["56c25610c866aa1700109ad7"],"version":"558444ceafccfd0d00fcb2bb","__v":1,"project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:58:54.366Z","from_sync":false,"order":14,"slug":"distributions","title":"Distributions"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-10T23:07:46.164Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -H 'X-API-TOKEN: yourtokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions/EMD_1X44FoEYDbwumfb/links?surveyId=SV_9iEUsdE4aB2K3Dj'","language":"curl"},{"code":"curl -H 'X-API-TOKEN: yourtokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions/EMD_1X44FoEYDbwumfb/links?surveyId=SV_9iEUsdE4aB2K3Dj&skipToken=MLRP_1YSZxPxV1a4GvR'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"result\": {\n        \"elements\": [\n            {\n                \"contactId\":\"CID_0Mpoz9Clg3gsbDb\",\n                \"link\": \"https://yourdatacenterid.qualtrics.com/WRQualtricsSurveyEngine?Q_DL=bQNtCGvkeC1rJs1_efmR5rlb76FBjy5_CGC_aabb1122cc3344d\",\n                \"linkExpiration\": \"2017-06-10T01:11:11Z\",\n                \"lastName\": \"Richard\",\n                \"firstName\": \"Christopher\",\n                \"externalDataReference\": null,\n                \"email\": \"sample:::at:::foo.com\",\n                \"unsubscribed\": false,\n                \"status\": \"Email not sent\"\n            },\n            {\n                \"contactId\":\"CID_0Mpoz9gg4hO9EDb\",\n                \"link\": \"https://yourdatacenterid.qualtrics.com/WRQualtricsSurveyEngine?Q_DL=bQNtCGvkeC1rJs1_efmR5rlb76FBjy5_CGC_aabb1122cc3344d\",\n                \"linkExpiration\": \"2017-06-10T01:11:11Z\",\n                \"lastName\": \"Mary\",\n                \"firstName\": \"Norris\",\n                \"externalDataReference\": null,\n                \"email\": \"sample@qoo.com\",\n                \"unsubscribed\": false,\n                \"status\": \"Email not sent\"\t\n            }\n        ],\n         \"nextPage\": \"https://yourdatacenter.qualtrics.com/API/v3/distributions/EMD_1X44FoEYDbwumfb/links?surveyId=SV_9iEUsdE4aB2K3Dj&skipToken=MLRP_cJa6UqHEx7atXCZ\"\n    },\n    },\n    \"meta\": {\n        \"httpStatus\": \"200 - OK\",\n        \"requestId\": \"7bc68a00-1b25-4f73-b6b1-4f3aec44f181\"\n    }\n}","name":""},{"code":"{\n    \"result\": {\n        \"elements\": [\n            {\n                \"contactId\": \"MLRP_cJa6UqHEx7atXCZ\",\n                \"link\": \"https://yourdatacenter.qualtrics.com/WRQualtricsSurveyEngine?Q_DL=7ZIodfjj3WmVL8N_9mZb3Wzkk34hXet_MLRP_cJa6UqHEx7atXCZ\",\n                \"linkExpiration\": \"null\",\n                \"status\": \"Email not sent\", //Does not contain valuable information\n                \"lastName\": null,\n                \"firstName\": \"firstName101\",\n                \"externalDataReference\": null,\n                \"email\": \"dummy101@gmail.com\",\n                \"unsubscribed\": \"0\"\n            },\n            {\n                \"contactId\": \"MLRP_7VviO8dlT13I7Pf\",\n                \"link\": \"https://yourdatacenter.qualtrics.com/WRQualtricsSurveyEngine?Q_DL=7ZIodfjj3WmVL8N_9mZb3Wzkk34hXet_MLRP_7VviO8dlT13I7Pf\",\n                \"linkExpiration\": \"null\",\n                \"status\": \"Email not sent\", //Does not contain valuable information\n                \"lastName\": null,\n                \"firstName\": \"firstName102\",\n                \"externalDataReference\": null,\n                \"email\": \"dummy102@gmail.com\",\n                \"unsubscribed\": \"0\"\n            }\n        ],\n        \"nextPage\": null\n    },\n    \"meta\": {\n        \"httpStatus\": \"200 - OK\",\n        \"requestId\": \"e9d4e94a-9a90-4cfc-a158-17d0dcbb819e\"\n    }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"57b7538f49a12a0e007b4704","ref":"","in":"path","required":true,"desc":"The ID returned from [Generate Distribution Invite](doc:generate-distribution-invite)","default":"","type":"string","name":"distributionId"},{"_id":"57b7538f49a12a0e007b4703","ref":"","in":"query","required":true,"desc":"The ID of the survey that the distribution belongs to","default":"","type":"string","name":"surveyId"},{"_id":"57ca0d502a7a6a0e00477e8f","ref":"","in":"query","required":false,"desc":"the pagination token to retrieve next page of distribution links. default to empty for the first page. The fix page size is 100.","default":"","type":"string","name":"skipToken"}],"url":"/v:version/distributions/:distributionId/links"},"isReference":false,"order":8,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Does not provide Email Status\",\n  \"body\": \"This call does not provide email status, and cannot be used to see the respondent's progress. This call is strictly meant to return the distribution links created in the [Generate Distribution Links](https://api.qualtrics.com/docs/generate-distribution-invite) call\"\n}\n[/block]","excerpt":"Retrieve a list of individual distribution links for an existing distribution, for unsubscribed contacts in specified mailing list, the link will be null. Refer to the documentation below for further information regarding usage of this API's result.","slug":"get-distribution-links","type":"endpoint","title":"List Distribution Links"}

getList Distribution Links

Retrieve a list of individual distribution links for an existing distribution, for unsubscribed contacts in specified mailing list, the link will be null. Refer to the documentation below for further information regarding usage of this API's result.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

distributionId:
required
string
The ID returned from [Generate Distribution Invite](doc:generate-distribution-invite)

Query Params

surveyId:
required
string
The ID of the survey that the distribution belongs to
skipToken:
string
the pagination token to retrieve next page of distribution links. default to empty for the first page. The fix page size is 100.

Examples


Result Format


Documentation

[block:callout] { "type": "danger", "title": "Does not provide Email Status", "body": "This call does not provide email status, and cannot be used to see the respondent's progress. This call is strictly meant to return the distribution links created in the [Generate Distribution Links](https://api.qualtrics.com/docs/generate-distribution-invite) call" } [/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 }}