Formstepdocs
Go to appApp

Reference

API blocks

Visual reference of every reusable API primitive. Compose into endpoint pages.

ApiEndpoint

HTTP method pill + path with copy-to-clipboard. Method auto-tones (GET=info, POST=success, etc).

GEThttps://api.formstep.io/v1/forms
POSThttps://api.formstep.io/v1/forms
PUThttps://api.formstep.io/v1/forms/{id}
PATCHhttps://api.formstep.io/v1/forms/{id}
DELETEhttps://api.formstep.io/v1/forms/{id}

ApiSection

Wraps a sub-section with optional title + auth badge.

List forms

API key
GEThttps://api.formstep.io/v1/forms

Admin: purge submissions

Admin only
DELETEhttps://api.formstep.io/v1/admin/submissions

Public health check

Public
GEThttps://api.formstep.io/v1/health

ApiParams + ApiParam

Parameter list. Each param has name, type, required/optional badge, optional default, optional enum chips.

Path params
idstringrequired
Form ID, e.g. frm_01HQ9X....
Body params4
namestringrequired
Form name.
statusenumoptionaldefault: draft
Initial publish state.
draftlivearchived
fieldsField[]optionaldefault: []
Array of field definitions.
legacy_idstringdeprecated
Use id instead.

ApiResponse

Status pill auto-tones (2xx success, 3xx info, 4xx warning, 5xx error). Body via slot — typically a CodeBlock.

200OK
json
{ "ok": true }
201Created
json
{ "id": "frm_..." }
400Bad request
json
{ "error": { "message": "Invalid body" } }
500Internal error
json
{ "error": { "message": "Internal server error" } }

CodeTabs

Tab switcher for sibling code examples. Slot names match each tab's value.