{"_id":"57028f8212b0f11900f9d604","user":"558435c2fb52ee0d0015d190","editedParams":true,"parentDoc":null,"project":"55843604fd8d910d007b9502","__v":2,"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":18,"slug":"distributions","title":"Distributions"},"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":60,"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","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T16:00:02.759Z","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\": \"EMD_8wSAjGvi4S1rvH7\",\n        \"parentDistributionId\": null,\n        \"ownerId\": \"UR_1M4aHozEkSxUfCl\",\n        \"organizationId\": \"exampleorganization1\",\n        \"requestStatus\": \"Done\",\n        \"requestType\": \"Invite\",\n        \"sendDate\": \"2015-11-17T00:36:42Z\",\n        \"createdDate\": \"2015-11-17T00:36:42Z\",\n        \"modifiedDate\": \"2015-11-17T00:36:43Z\",\n        \"headers\": {\n          \"fromEmail\": \"apiexample:::at:::qualtrics.com\",\n          \"replyToEmail\": \"apiexample@qualtrics.com\",\n          \"fromName\": \"Api Test\",\n          \"subject\": \"Example Subject\"\n        },\n        \"recipients\": {\n          \"mailingListId\": \"ML_01gl1yHFWKSU8y9\",\n          \"contactId\": null,\n          \"libraryId\": \"UR_1M4aHozEkSxUfCl\",\n          \"sampleId\": null\n        },\n        \"message\": {\n          \"libraryId\": \"UR_1M4aHozEkSxUfCl\",\n          \"messageId\": \"MS_0Vdgn7nLGSQBlYN\",\n          \"messageText\": null\n        },\n        \"surveyLink\": {\n          \"surveyId\": \"SV_0iEUsdE4aB4K0Dj\",\n          \"expirationDate\": \"2016-01-16T00:36:42Z\",\n          \"linkType\": \"Individual\"\n        },\n        \"stats\": {\n          \"sent\": 5,\n          \"failed\": 0,\n          \"started\": 0,\n          \"bounced\": 0,\n          \"opened\": 0,\n          \"skipped\": 0,\n          \"finished\": 0,\n          \"complaints\": 0,\n          \"blocked\": 0\n        }\n      },\n      {\n        \"id\": \"EMD_a4y9QGA0sGBRzmt\",\n        \"parentDistributionId\": null,\n        \"ownerId\": \"UR_1M4aHozEkSxUfCl\",\n        \"organizationId\": \"exampleorganization2\",\n        \"requestStatus\": \"Done\",\n        \"requestType\": \"Invite\",\n        \"sendDate\": \"2015-11-17T00:36:26Z\",\n        \"createdDate\": \"2015-11-17T00:36:26Z\",\n        \"modifiedDate\": \"2015-11-17T00:36:29Z\",\n        \"headers\": {\n          \"fromEmail\": \"apitest@qualtrics.com\",\n          \"replyToEmail\": \"apitest@qualtrics.com\",\n          \"fromName\": \"Api Tester\",\n          \"subject\": \"Example Subject 2\"\n        },\n        \"recipient\": {\n          \"mailingListId\": \"ML_01gl1yHFWKSU8y9\",\n          \"contactId\": null,\n          \"libraryId\": \"UR_1M4aHozEkSxUfCl\",\n          \"sampleId\": null\n        },\n        \"message\": {\n          \"libraryId\": \"UR_1M4aHozEkSxUfCl\",\n          \"messageId\": \"MS_0Vdgn7nLGSQBlYN\",\n          \"messageText\": null\n        },\n        \"surveyLink\": {\n          \"surveyId\": \"SV_0iEUsdE4aB4K0Dj\",\n          \"expirationDate\": \"2016-01-16T00:36:26Z\",\n          \"linkType\": \"Individual\"\n        },\n        \"stats\": {\n          \"sent\": 5,\n          \"failed\": 0,\n          \"started\": 0,\n          \"bounced\": 0,\n          \"opened\": 0,\n          \"skipped\": 0,\n          \"finished\": 0,\n          \"complaints\": 0,\n          \"blocked\": 0\n        }\n      },\n      {\n        \"id\": \"EMD_5yzfr30Fbpnmu8t\",\n        \"parentDistributionId\": \"EMD_a4y9QGA0sGBRzmt\",\n        \"ownerId\": \"UR_1M4aHozEkSxUfCl\",\n        \"organizationId\": \"exampleorganization3\",\n        \"requestStatus\": \"Done\",\n        \"requestType\": \"Reminder\",\n        \"sendDate\": \"2015-11-17T00:36:42Z\",\n        \"createdDate\": \"2016-02-16T01:10:30Z\",\n        \"modifiedDate\": \"2016-02-16T01:10:33Z\",\n        \"headers\": {\n          \"fromEmail\": \"apitest@qualtrics.com\",\n          \"replyToEmail\": \"noreply@qualtrics.com\",\n          \"fromName\": \"Api Tester\",\n          \"subject\": \"Example Subject\"\n        },\n        \"recipients\": {\n          \"mailingListId\": null,\n          \"contactId\": null,\n          \"libraryId\": null,\n          \"sampleId\": null\n        },\n        \"message\": {\n          \"libraryId\": \"UR_1M4aHozEkSxUfCl\",\n          \"messageId\": \"MS_0Vdgn7nLGSQBlYN\",\n          \"messageText\": null\n        },\n        \"surveyLink\": {\n          \"surveyId\": \"SV_0iEUsdE4aB4K0Dj\",\n          \"expirationDate\": null,\n          \"linkType\": null\n        },\n        \"stats\": {\n          \"sent\": 0,\n          \"failed\": 0,\n          \"started\": 0,\n          \"bounced\": 0,\n          \"opened\": 0,\n          \"skipped\": 0,\n          \"finished\": 0,\n          \"complaints\": 0,\n          \"blocked\": 0\n        }\n      }\n    ],\n    \"nextPage\": \"https://s.qualtrics.com/API/v3/distributions?surveyId=SV_0iEUsdE4aB4K0Dj&offset=100\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"meta\": {\n        \"httpStatus\": \"400 - Bad Request\",\n        \"error\": {\n            \"errorMessage\": \"Invalid surveyId parameter.\",\n            \"errorCode\": \"GD_1.0\"\n        },\n        \"requestId\": null\n    }\n}"},{"code":"{\n    \"meta\": {\n        \"httpStatus\": \"401 - Unauthorized\",\n        \"error\": {\n            \"errorMessage\": \"Unrecognized X-API-TOKEN.\",\n            \"errorCode\": \"DCD_7\"\n        },\n        \"requestId\": null\n    }\n}\n","language":"json","status":401}]},"settings":"","examples":{"codes":[{"code":"curl -H 'X-API-TOKEN: yourtokenhere'\n'yourdatacenterid.qualtrics.com/API/v3/distributions?surveyId=SV_0iEUsdE4aB4K0Dj'","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"5627c287e2ce610d004e3f39","ref":"","in":"query","required":true,"desc":"The survey ID associated with the distributions","default":"","type":"string","name":"surveyId"},{"_id":"5627c33afcbbc621004ec074","ref":"","in":"query","required":false,"desc":"The mailing list or contact group associated with the distribution(s)","default":"","type":"string","name":"mailingListId"},{"_id":"5627c33afcbbc621004ec073","ref":"","in":"query","required":false,"desc":"Specify the type of distribution. Possible values are: Invite, ThankYou, Reminder, Email, Portal, PortalInvite, GeneratedInvite","default":"","type":"string","name":"distributionRequestType"},{"_id":"5627c33afcbbc621004ec070","ref":"","in":"query","required":false,"desc":"Starting range on the distribution send date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.","default":"","type":"datetime","name":"sendStartDate"},{"_id":"5627c33afcbbc621004ec06f","ref":"","in":"query","required":false,"desc":"Ending range on the distribution send date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.","default":"","type":"datetime","name":"sendEndDate"},{"_id":"595fb4ce729792002d8b3e14","ref":"","in":"query","required":false,"desc":"The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.","default":"","type":"int","name":"offset"}],"url":"/v:version/distributions"},"isReference":false,"order":5,"body":"","excerpt":"Get all distributions","slug":"get-distributions","type":"endpoint","title":"List Distributions"}

getList Distributions

Get all distributions

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

surveyId:
required
string
The survey ID associated with the distributions
mailingListId:
string
The mailing list or contact group associated with the distribution(s)
distributionRequestType:
string
Specify the type of distribution. Possible values are: Invite, ThankYou, Reminder, Email, Portal, PortalInvite, GeneratedInvite
sendStartDate:
datetime
Starting range on the distribution send date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.
sendEndDate:
datetime
Ending range on the distribution send date. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.
offset:
integer
The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.

Examples


Result Format


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