Forms

The Form Builder Form Object

The FormBuilderForm object represents a configurable form definition used for collecting submissions. It includes display/configuration fields, activation window, submission behaviour settings (e.g. redirect, one-response limits, recaptcha), and links to campaign/list/templates. When requested with fields included, it also contains the full field schema for rendering the form in clients.

Value	Type	Description
uuid	string	Form UUID.
name	string	Form name.
description	string	Form description.
status	string	Form status.
start_date	string	Start date/time.
end_date	string	End date/time.
archived_at	string	Archive timestamp.
submission_behaviour	string	Submission behaviour mode.
redirect_url	string	Redirect URL.
message	string	Form message.
one_response_per_listener	boolean	Restrict to one response per listener.
one_response_per_ip_address	boolean	Restrict to one response per IP.
use_recaptcha_verification	boolean	Recaptcha verification enabled.
create_listener	boolean	Create listener from submission.
created_at	string	Record creation timestamp.
updated_at	string	Record update timestamp.
station_uuid	string	Station UUID when station_id is present.
campaign	object	Serialized Campaign object when present and not NullCampaign.
css_template_uuid	string	CSS template UUID when present.
confirmation_template_uuid	string	Confirmation template UUID when present.
list	object	Serialized List object when present and not NullList.
fields	array	Array of serialized FormBuilderFormField objects when include_fields option is true.

The Form Builder Form Field Object

The FormBuilderFormField object represents a single field definition inside a form. It provides the field’s position, type, name, options payload, and station context. Together, these field objects define the structure and behaviour of the questions/inputs shown to end users.

Value	Type	Description
uuid	string	Form field UUID.
position	integer	Display/order position.
type	string	Field type.
name	string	Field name.
options	array/object	Field options payload.
station_uuid	string	Station UUID when station_id is present.