Forms API

Manage forms programmatically — useful for provisioning forms per customer, automating migrations, or building your own dashboard.

List forms

bash

GET /v1/forms
Authorization: Bearer af_live_...

Returns a paginated list of forms in your workspace.

bash

GET /v1/forms/:id

Returns the full form schema including steps, fields, and logic rules.

bash

POST /v1/forms
Content-Type: application/json

{
  "name": "Contact us",
  "slug": "contact",
  "steps": [...]
}

bash

PATCH /v1/forms/:id
Content-Type: application/json

{ "name": "New name" }

Any field you omit is left unchanged. Use PATCH, not PUT.

bash

DELETE /v1/forms/:id

Deletes the form and all its submissions. This is permanent — make sure you've exported anything you need first.

Was this page helpful?