Types

FormField

A field of a form.

idrequired
string (uuid)
The field id.
labelrequired
string | null
The question shown to the person filling in the form.
namerequired
string | null
The field's short name.
descriptionrequired
string | null
Help text shown under the question.
typerequired
string | null
The field type, such as TEXT or DROPDOWN.
referencerequired
string | null
A key that stays stable across edits, unique within the form.
validatorrequired
string | null
Validation rules, separated by a pipe, such as required|string.
placeholderrequired
string | null
Placeholder text.
pre_population_keyrequired
string | null
The profile value that pre-fills this field.
backfillrequired
boolean
Whether the answer is written back to the profile.
orderrequired
integer | null
The field's position within the form.
page_idrequired
string | null (uuid)
The page the field sits on.
option_preset_idrequired
string | null (uuid)
The option preset a dropdown field takes its options from.
optionsrequired
array | object | null
The options of a dropdown or similar field.
requiredrequired
boolean
Whether an answer is required. Read-only: it follows the validator.
conditionsrequired
object[]
Conditions that show this field only when another field has a given answer.
condition_logicrequired
string
Whether all conditions (AND) or any one (OR) must hold.One of: AND, OR

Used by (4)