Form Builder
The authoring surface for dynamic forms. These endpoints back the visual form editor in the S-Launch UI and any custom tooling that needs to create, modify, or version form definitions. The runtime/consumption surface lives under Form Viewer.
Scopes
| Scope | Reach |
|---|---|
formbuilder:read | Listing, reading, fetching thumbnails. |
formbuilder:write | Creating, updating, deleting, uploading thumbnails. |
Endpoints
List Forms
GET /api/formbuilder/
Returns a page of form definitions.
Required scope: formbuilder:read · also accepts API key
Query parameters — standard pagination set; see Conventions › Pagination. Defaults: sort_by=created, sort_order=desc, hydrate=true.
Response 200 — FormInDbCursorPage
Get Form Filter Metadata
GET /api/formbuilder/filters
Returns filter/operator/sort options for List Forms.
Required scope: formbuilder:read
Response 200 — open metadata object.
Get Form by ID
GET /api/formbuilder/{id}
Returns a single form definition — the authoring view, which exposes the full schema, validation, and step structure.
Required scope: formbuilder:read · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Form ID. |
Response 200 — FormRead
Get Form Thumbnail
GET /api/formbuilder/{id}/thumbnail
Returns the thumbnail image for the form (used by gallery views in the UI).
Required scope: formbuilder:read
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Form ID. |
Response 200 — image bytes.
Create Form
POST /api/formbuilder/
Creates a new form definition.
Required scope: formbuilder:write
Request body — FormWriteCreate
Response 201 — FormRead
Update Form by ID
PUT /api/formbuilder/{id}
Replaces the form definition.
Required scope: formbuilder:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Form ID. |
Request body — FormWriteReplace
Response 200 — FormRead
Patch Form
PATCH /api/formbuilder/{id}
Partial form definition update.
Required scope: formbuilder:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Form ID. |
Request body — FormWriteUpdate
Response 200 — FormRead
Delete Form by ID
DELETE /api/formbuilder/{id}
Deletes the form definition. Existing Submissions for the form are retained as historical records.
Required scope: formbuilder:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Form ID. |
Response 204 — empty.
Upload Form Thumbnail
POST /api/formbuilder/{id}/thumbnail
Uploads a thumbnail image for the form.
Required scope: formbuilder:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Form ID. |
Request body — Body_Form_Builder-upload_thumbnail (multipart/form-data).
Response 200 — FormRead
See also
- Form Viewer — the consumption side of the same forms.
- Submissions — submission records produced when users complete a form.