Forms

Manage forms — create, update, publish, and delete forms in your workspace.

Endpoints

GET/api/v1/forms

List forms — Returns all forms in the workspace, sorted by most recently updated.

Required permissions:forms:read

client.forms.get()

POST/api/v1/forms

Create a form — Creates a new form in draft status.

Required permissions:forms:write

client.forms.post(body)

GET/api/v1/forms/{id}

Get a form — Returns the form with all sections and questions.

Required permissions:forms:read

client.forms.byId("ID").get()

PUT/api/v1/forms/{id}

Update a form — Update title, description, or status.

Required permissions:forms:write

client.forms.byId("ID").put(body)

DELETE/api/v1/forms/{id}

Delete a form — Soft-deletes by default. Add ?permanent=true to permanently delete.

Required permissions:forms:delete

client.forms.byId("ID").delete()

POST/api/v1/forms/{id}/publish

Publish a form — Publishes the current draft as the next revision. Requires user-backed auth context in addition to the forms:publish permission.

Required permissions:forms:writeforms:publish

client.forms.byId("ID").publish.post(body)

This page is auto-generated from the OpenAPI spec. Run npm run docs:generate to update.