Skip to the documentation
API

Form starters

The starting points the app offers when somebody makes a form: a newsletter, a waitlist, an event, early access, a contact form and a blank one. They ship with the product, so the list is the same for every workspace.

GET/forms/starters

Runs any of 2 calls on your workspace.

GET /forms/starters

The starting points the app offers when somebody makes a form: a newsletter, a waitlist, an event, early access, a contact form and a blank one. They ship with the product, so the list is the same for every workspace.

Example

Needs forms:read. The list leaves the documents out. GET /forms/starters/{slug} returns one starter with its document, so you can change it before creating a form from it.

curl
curl "$OE/forms/starters/newsletter" -H "$AUTH"
Response
{  "object": "form_starter",  "slug": "newsletter",  "name": "Newsletter sign-up",  "description": "Name, email and consent for a regular newsletter.",  "document": { "fields": ["…"], "copy": { "title": "Subscribe to our newsletter" }, "style": { "accent": "#18181b" } }}

Pass a slug as starter when you create a form, and the server copies the starter for you.

Reference