Types

FlowTemplateField

One field of a template page.

referencerequired
string
The field's key within the template. Conditions name fields by it.
typerequired
string
The field type, such as `TEXT`, `DROPDOWN` or `CHECKBOX`.
labelrequired
string
The question shown to the respondent.
descriptionrequired
string | null
Help text under the question.
optionsrequired
array | null
The choices of a dropdown or similar field, or null.
requiredrequired
boolean
Whether an answer is required.
display_conditionsrequired
array | null
Conditions that show the field only for some answers, or null when it is always shown.