Skip to content

Questions

A question is a block with kind: "field":

A question
{
"kind": "field",
"key": "email",
"type": "email",
"label": "Work email",
"required": true,
"placeholder": "maya@northwind.co",
"autocomplete": "email"
}
typeWhat it isIts own propertiesIts answer
textOne lineminLength, maxLength (500), patternstring
textareaSeveral linesminLength, maxLength (5000), rowsstring
emailAn email address—string
phoneA phone numberdefaultCountrystring, as typed
urlA web address"northwind.co" is acceptedstring, with https://
numberA numbermin, max, step, integer, prefix, suffix, unitPricenumber
choicePick one or severaldisplay, options, multiple, minSelected, maxSelected, otheran option's value, or an array of them
checkboxOne tick boxprice (added when ticked)boolean
consentAgreeing to exact wordingbodyboolean
quantityA steppermax (required), min, step, unitPrice, unitLabelinteger
dateA datemin, max (a date, or today, +5d, +3m), disabledWeekdays, blockedDates"YYYY-MM-DD"
timeA timemin, max, stepMinutes"HH:mm"
fileFile uploadaccept, maxSizeMB, maxFiles (1, at most 10)a list of files
ratingStars or a number scalemax (5 or 10), display, min, minLabel, maxLabelinteger
hiddenA value the visitor doesn't seesource: { query }, { const } or { page }string
paymentA card payment, through Stripeamount: { fixed }, { from: "total" | "deposit" } or { expr }the payment, set by our server
bookingA date and time from the owner's calendardurationMinutes, daysAhead (14)the booking, set by our server
keystringrequired
The answer’s name. Frozen at first publish.
typestringrequired
One of the types above.
labelstringrequired
Always there, for screen readers, even when hidden with labelHidden.
dataLabelstring
The column name in exports and apps. Defaults to the label.
helprich text
A line of help under the question.
placeholderstring
Shown in an empty field.
requiredboolean
Must be answered.
requiredWhenCondition
Must be answered when this is true.
visibleWhenCondition
Only shows when this is true.
defaultanswer
The value it starts with.
prefill{ param }
Fills in from the page’s address: { "param": "plan" } reads ?plan=…. Ignored on consent, file, payment, booking and hidden questions.
autocompletestring
An HTML autocomplete token, such as email or postal-code.
widthfull | half | third
A hint. Questions stack on a phone.
messagesobject
Your own wording for this question’s errors.
introstring
In a conversational form, a line above the question.
personalboolean
Marks an answer as personal. Nothing reads it yet: finding a person searches every answer.
readOnlyboolean
Shown but can’t be changed.
A choice question
{
"kind": "field",
"key": "budget",
"type": "choice",
"label": "What's your budget?",
"display": "cards",
"options": [
{ "value": "under-10k", "label": "Under $10k" },
{ "value": "10k-25k", "label": "$10k–$25k", "description": "Most projects" },
{ "value": "25k-plus", "label": "$25k+" }
],
"other": { "label": "Something else" }
}
  • display is radio, chips, cards, segment, dropdown, swatch or image. Every one is a real radio button or tick box underneath.
  • A question has 1 to 24 options, or up to 500 in a dropdown.
  • An option’s value is what answers, logic and apps use, never its label. An option can have a price, added when it’s picked.
  • With other, picking it sets the answer to other, and what the visitor typed arrives as a separate answer, <key>__other.

A file answer is a list of { id, name, size, type }. In a webhook or the API each also has a url, and files are served from their own domain with Content-Disposition: attachment, so an uploaded page can never run as your site.

Was this helpful?

Your answer goes straight to the person who wrote it.

Thanks. We read every note and update the article.

Thanks, that helps us keep these useful.

ChatGPT is a trademark of OpenAI, and Claude and Claude Code are trademarks of Anthropic. Other product names and logos belong to their owners. None of them makes or endorses Seaforms. Trademarks