Surveys
Retrieve Survey
Retrieve a specific survey by its ID
get/surveys/{id}
Path parameters
idstring required
Response
OK
idstring required
A unique TypeID associated with the object.
creation_datestring date-time required
The date and time at which the object was first created.
identifierstring required
A newsletter-scoped slug used to reference this survey when embedding it in emails.
questionstring required
The survey question shown to subscribers.
response_countinteger required
The total number of responses this survey has received.
answersstring[] required
The list of pre-defined answer choices. Order is preserved unless randomize_answers is true.
notesstring required
Internal notes about the survey. Not shown to subscribers.
randomize_answersboolean required
If true, the order of answers is shuffled each time the survey is rendered.
response_cadence'once' | 'once_per_email' required
An enumeration.
status'active' | 'inactive' required
An enumeration.
is_freeform_response_enabledboolean required
If true, subscribers can provide a freeform text response in addition to (or instead of) picking from answers.
input_type'radio' | 'checkbox' | 'text' required
An enumeration.