Forms

The Forms API is the engine behind every customisable form on the platform — it manages form definitions with their fields and lifecycle state, the re-usable document templates that derive rendered documents from them, and the per-user implementations that capture answers progressively through to completion.

Domain model

  • Forms — top-level form definitions: fields, validation, lifecycle state.
  • Implementations — a user's instance of a form. Saves answers progressively and can be marked complete.
  • Implementation documents — generated documents (e.g. PDFs) produced from a template against a completed implementation.
  • Templates — re-usable document templates bound to forms; each template can render a document for a given implementation.
  • Form fields — per-field metadata, including compatibility checks and bulk import/export of field definitions.
  • Files — file uploads referenced by form fields.
  • Option presets — reusable lists of options that fields with select/dropdown semantics can pull from.

Endpoints

Forms

Get all forms

Paginated list of all form definitions in the tenant.

Get form

Fetch a single form definition by UUID.

Create form

Define a new form.

Edit form

Update an existing form definition.

Delete form

Permanently remove a form definition.

Change form state

Transition a form through its lifecycle states (draft, published, archived).

Implementations

Get form implementation

Fetch a single form implementation, including saved answers.

Get form implementations

List all implementations for a specific form.

Get assigned form implementations

List implementations assigned to a given user or deal.

Get many form implementations by UUID

Retrieve multiple implementations by a list of UUIDs.

Create form implementation

Create an implementation associating a form with a user or deal.

Create form implementations

Bulk-create multiple implementations for a single form.

Save form implementation

Persist field answers against an in-progress implementation.

Complete form implementation

Mark a form implementation as completed.

Delete form implementation

Permanently remove a form implementation.

Save form to implementation

Save the current form state directly to an implementation.

Implementation documents

Get form implementation document

Fetch a single generated document for a form implementation.

Get form implementation documents

List all generated documents for a form implementation.

Delete form implementation document

Remove a generated document from a form implementation.

Create document from form template for implementation

Generate a document by applying a template to a completed implementation.

Templates

Get form templates

List all document templates attached to a form.

Create form template

Attach a new document template to a form.

Delete form templates

Remove document templates from a form.

Form fields

Delete form field

Remove a single field definition from its parent form.

Get form field compatible types

List the field types a field can be converted to without data loss.

Export form fields

Export all field definitions for a form as a downloadable file.

Import form fields

Bulk-import field definitions from an exported file.

Files

Store file

Upload and store a file in the form-builder file store.

Get file

Retrieve metadata and content for a stored file.

Download file

Download raw file content from the form-builder file store.

Delete file

Permanently remove a stored file.

Option presets

Get all form option presets

List all reusable option presets available in the tenant.

Get form option preset

Fetch a single option preset by UUID.

Create form option preset

Create a new reusable option preset.

Update form option preset

Modify an existing option preset.

Delete form option preset

Permanently remove an option preset.

Validate import presets

Validate option preset data before importing.