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 of List Distributions response. The messageType tells what type of message is defined for the distribution. For Library the content can be found using the Get Library Message endpoint. For Inline the content is part of the Get Distribution response.

Request Params

KeyDatatypeRequiredDescription
mailingListIdstring
surveyIdstring(Required) The ID of the survey to which the distribution belongs.
distributionRequestTypestringSpecify the type of distribution. Possible values are: Invite, ThankYou, Reminder, Email, Portal, PortalInvite, GeneratedInvite.
sendStartDatestring
sendEndDatestring
pageSizenumber
skipTokenstring
offsetnumber
useNewPaginationSchemeboolean

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;elements&quot;:[{&quot;id&quot;:&quot;EMD_1234567890abcde&quot;,&quot;parentDistributionId&quot;:&quot;EMD_1234567890abcde&quot;,&quot;ownerId&quot;:&quot;UR_1M4aHozEkSxUfCl&quot;,&quot;organizationId&quot;:&quot;exampleorganization1&quot;,&quot;requestStatus&quot;:&quot;non et id&quot;,&quot;requestType&quot;:&quot;\u003cstring\u003e&quot;,&quot;sendDate&quot;:&quot;1959-04-18T03:26:42.013Z&quot;,&quot;createdDate&quot;:&quot;1994-04-05T12:47:17.243Z&quot;,&quot;modifiedDate&quot;:&quot;2021-11-05T16:07:21.282Z&quot;,&quot;headers&quot;:{&quot;fromEmail&quot;:&quot;apiexample@qualtrics.com&quot;,&quot;replyToEmail&quot;:&quot;apiexample@qualtrics.com&quot;,&quot;fromName&quot;:&quot;Test Name&quot;,&quot;subject&quot;:&quot;Example Subject&quot;},&quot;recipients&quot;:{&quot;mailingListId&quot;:&quot;CG_012345678901234&quot;,&quot;contactId&quot;:&quot;CGC_012345678901234&quot;,&quot;libraryId&quot;:&quot;UR_1M4aHozEkSxUfCl&quot;,&quot;sampleId&quot;:&quot;CG_012345678901235&quot;},&quot;message&quot;:{&quot;libraryId&quot;:&quot;UR_1M4aHozEkSxUfCl&quot;,&quot;messageId&quot;:&quot;MS_0Vdgn7nLGSQBlYN&quot;,&quot;messageText&quot;:&quot;Ut id incididunt do&quot;,&quot;messageType&quot;:&quot;Inline&quot;},&quot;surveyLink&quot;:{&quot;surveyId&quot;:&quot;SV_cHbKMOdeT8NetF3&quot;,&quot;expirationDate&quot;:&quot;1961-01-29T11:02:53.192Z&quot;,&quot;linkType&quot;:&quot;Anonymous&quot;},&quot;stats&quot;:{&quot;sent&quot;:0,&quot;failed&quot;:0,&quot;started&quot;:0,&quot;bounced&quot;:0,&quot;opened&quot;:0,&quot;skipped&quot;:0,&quot;finished&quot;:0,&quot;complaints&quot;:0,&quot;blocked&quot;:0},&quot;embeddedData&quot;:{}},{&quot;id&quot;:&quot;EMD_1234567890abcde&quot;,&quot;parentDistributionId&quot;:&quot;EMD_1234567890abcde&quot;,&quot;ownerId&quot;:&quot;UR_1M4aHozEkSxUfCl&quot;,&quot;organizationId&quot;:&quot;exampleorganization1&quot;,&quot;requestStatus&quot;:&quot;sed reprehenderit veniam sit&quot;,&quot;requestType&quot;:&quot;\u003cstring\u003e&quot;,&quot;sendDate&quot;:&quot;1953-01-04T06:46:20.944Z&quot;,&quot;createdDate&quot;:&quot;1993-07-03T18:28:57.483Z&quot;,&quot;modifiedDate&quot;:&quot;1988-05-09T04:17:32.625Z&quot;,&quot;headers&quot;:{&quot;fromEmail&quot;:&quot;apiexample@qualtrics.com&quot;,&quot;replyToEmail&quot;:&quot;apiexample@qualtrics.com&quot;,&quot;fromName&quot;:&quot;Test Name&quot;,&quot;subject&quot;:&quot;Example Subject&quot;},&quot;recipients&quot;:{&quot;mailingListId&quot;:&quot;CG_012345678901234&quot;,&quot;contactId&quot;:&quot;CGC_012345678901234&quot;,&quot;libraryId&quot;:&quot;UR_1M4aHozEkSxUfCl&quot;,&quot;sampleId&quot;:&quot;CG_012345678901235&quot;},&quot;message&quot;:{&quot;libraryId&quot;:&quot;UR_1M4aHozEkSxUfCl&quot;,&quot;messageId&quot;:&quot;MS_0Vdgn7nLGSQBlYN&quot;,&quot;messageText&quot;:&quot;magna commodo&quot;,&quot;messageType&quot;:&quot;Inline&quot;},&quot;surveyLink&quot;:{&quot;surveyId&quot;:&quot;SV_cHbKMOdeT8NetF3&quot;,&quot;expirationDate&quot;:&quot;2023-01-03T09:31:08.181Z&quot;,&quot;linkType&quot;:&quot;Individual&quot;},&quot;stats&quot;:{&quot;sent&quot;:0,&quot;failed&quot;:0,&quot;started&quot;:0,&quot;bounced&quot;:0,&quot;opened&quot;:0,&quot;skipped&quot;:0,&quot;finished&quot;:0,&quot;complaints&quot;:0,&quot;blocked&quot;:0},&quot;embeddedData&quot;:{}}],&quot;nextPage&quot;:&quot;pariatur commodo m&quot;},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;sint fugiat esse&quot;,&quot;requestId&quot;:&quot;fu&quot;,&quot;notice&quot;:&quot;anim ex Duis&quot;}}