Skip to main content
GET
Get a form definition

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path Parameters

slug
string
required

URL-friendly identifier of the form.

Response

The form definition.

Definition of a storefront form, used to render it and validate submissions.

name
string

Form name.

fields
object[]

The form's fields, in display order.

settings
object

Display settings for the form.