List Distribution Links
GET/distributions/:distributionId/links
Returns a list of individual distribution links for an existing distribution.
This API call always returns an email status of “Email not sent” and does not report respondent progress.
It is intended only to retrieve distribution links that were generated (but not sent) using the Create Distribution API. Requesting distributions that were created by other means will update the email status dates to the current date of the API request in places like the contact’s timeline or respondent funnel. Run this endpoint repeatedly for a distributionId only until nextPage is null. Do not call the API again for that same distributionId to avoid redundant requests and unintended status updates.
To monitor the respondent’s progress or retrieve survey links for a second time, call the List Distribution History API for the distributionId specified in your request. For additional details on returned contacts, refer to the Get Directory Contact API.
A distribution event will count toward contact frequency for each contact returned by the API.
This API call does not return contacts who are opted out (unsubscribed).
Request
Responses
- 200
- default
A collection of distribution links
A default error response