List Distributions
GET {{baseUrl}}/distributions?mailingListId=CG_012345678901234&surveyId=SV_cHbKMOdeT8NetF3&distributionRequestType=GeneratedInvite&sendStartDate=2017-07-21T17:32:28Z&sendEndDate=2017-07-21T17:32:28Z&pageSize=100&skipToken=labore cillum incididunt eu ipsum&offset=0&useNewPaginationScheme=false
Return a list of all distributions.
The new string-based pagination functionality enables performance improvements. To opt in, append the query parameter useNewPaginationScheme=true
.
<!-- theme: warning -->
Message Text
Starting June 1, 2022,
messageText
is not part ofList Distributions
response. ThemessageType
tells what type of message is defined for the distribution. ForLibrary
the content can be found using theGet Library Message
endpoint. ForInline
the content is part of theGet Distribution
response.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
mailingListId | string | ||
surveyId | string | (Required) The ID of the survey to which the distribution belongs. | |
distributionRequestType | string | Specify the type of distribution. Possible values are: Invite , ThankYou , Reminder , Email , Portal , PortalInvite , GeneratedInvite . | |
sendStartDate | string | ||
sendEndDate | string | ||
pageSize | number | ||
skipToken | string | ||
offset | number | ||
useNewPaginationScheme | boolean |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"id":"EMD_1234567890abcde","parentDistributionId":"EMD_1234567890abcde","ownerId":"UR_1M4aHozEkSxUfCl","organizationId":"exampleorganization1","requestStatus":"non et id","requestType":"\u003cstring\u003e","sendDate":"1959-04-18T03:26:42.013Z","createdDate":"1994-04-05T12:47:17.243Z","modifiedDate":"2021-11-05T16:07:21.282Z","headers":{"fromEmail":"apiexample@qualtrics.com","replyToEmail":"apiexample@qualtrics.com","fromName":"Test Name","subject":"Example Subject"},"recipients":{"mailingListId":"CG_012345678901234","contactId":"CGC_012345678901234","libraryId":"UR_1M4aHozEkSxUfCl","sampleId":"CG_012345678901235"},"message":{"libraryId":"UR_1M4aHozEkSxUfCl","messageId":"MS_0Vdgn7nLGSQBlYN","messageText":"Ut id incididunt do","messageType":"Inline"},"surveyLink":{"surveyId":"SV_cHbKMOdeT8NetF3","expirationDate":"1961-01-29T11:02:53.192Z","linkType":"Anonymous"},"stats":{"sent":0,"failed":0,"started":0,"bounced":0,"opened":0,"skipped":0,"finished":0,"complaints":0,"blocked":0},"embeddedData":{}},{"id":"EMD_1234567890abcde","parentDistributionId":"EMD_1234567890abcde","ownerId":"UR_1M4aHozEkSxUfCl","organizationId":"exampleorganization1","requestStatus":"sed reprehenderit veniam sit","requestType":"\u003cstring\u003e","sendDate":"1953-01-04T06:46:20.944Z","createdDate":"1993-07-03T18:28:57.483Z","modifiedDate":"1988-05-09T04:17:32.625Z","headers":{"fromEmail":"apiexample@qualtrics.com","replyToEmail":"apiexample@qualtrics.com","fromName":"Test Name","subject":"Example Subject"},"recipients":{"mailingListId":"CG_012345678901234","contactId":"CGC_012345678901234","libraryId":"UR_1M4aHozEkSxUfCl","sampleId":"CG_012345678901235"},"message":{"libraryId":"UR_1M4aHozEkSxUfCl","messageId":"MS_0Vdgn7nLGSQBlYN","messageText":"magna commodo","messageType":"Inline"},"surveyLink":{"surveyId":"SV_cHbKMOdeT8NetF3","expirationDate":"2023-01-03T09:31:08.181Z","linkType":"Individual"},"stats":{"sent":0,"failed":0,"started":0,"bounced":0,"opened":0,"skipped":0,"finished":0,"complaints":0,"blocked":0},"embeddedData":{}}],"nextPage":"pariatur commodo m"},"meta":{"httpStatus":"sint fugiat esse","requestId":"fu","notice":"anim ex Duis"}}