Types

DataCaptureForm

A data capture form, the fields a firm asks users for, with the status that switches it on.

idrequired
string (uuid)
The data capture form id. It is not the id of the hidden form underneath.
namerequired
string
The form's display name.
statusrequired
string
`enabled` captures the form's fields against every user, `internal_only` against internal users only, and `disabled` stops capturing. A new form is disabled.One of: enabled, disabled, internal_only
field_countrequired
integer
How many fields the form has. Read-only.
pagesrequired
object[]
The form's pages, in order.
fieldsrequired
object[]
The form's fields, in order. A field's `reference` is the key its answer is stored under. Send them back on create and update to author the form in one call.
created_atrequired
string (date-time)
When the form was created.
updated_atrequired
string | null (date-time)
When the form last changed.

Used by (4)