Get Form
Retrieve a single form by its slug (UUID or human-readable slug).Authentication & Scope
Requires a token with theforms-read
ability.
Request
Path Parameters
Parameter | Type | Description |
---|---|---|
slug | string | The form slug or UUID (see dashboard) |
Response
200 OK
– Returns a Form
object.
404 Not Found
– No form matches the provided slug.
403 Forbidden
– The token lacks the required ability or you do not have permission to view the form.Authorizations
Personal Access Token
Path Parameters
Response
Successful
The unique identifier for the form.
The URL-friendly slug for the form.
The title of the form.
The current visibility state of the form.
Available options:
public
, draft
, closed
Two-letter ISO language code.
Available options:
default
, simple
, notion
Available options:
light
, dark
, auto
Available options:
centered
, full
Available options:
sm
, md
, lg
Available options:
none
, small
, full
Whether to hide the OpnForm branding.
Transparent background when form is embedded.
Maximum length:
50
Maximum length:
2000
Maximum length:
50
Required range:
x >= 1
Maximum length:
50
Available options:
recaptcha
, hcaptcha
An array of field and layout blocks that make up the form.