Formspark Octri Preview
GET/forms/{formId}

Get a form

Retrieves a form by its formId. Use this operation to inspect the form's configuration, including its submission settings, notification options, and spam protection settings.

1 parameter
formIdstringrequired
The unique identifier of the form to retrieve. Must contain at least one character.

7 status codes
200Returns the form object, including its identifier, name, configuration, and creation timestamp.
allowedDomainsarray<string>required
The sites a submission may be sent from. Each entry also covers its subdomains. Empty means submissions are accepted from anywhere.
automaticSpamFilterbooleanrequired
createdAtstringrequired
customHoneypotstringrequired
customSpamWordsstringrequired
descriptionstringrequired
emailThreadingbooleanrequired
idstringrequired
namestringrequired
notificationEmailsarray<string>required
slackChannelstringrequired
spamProtectionstringrequired
Allowed:BOTPOISONGOOGLE_RECAPTCHA_V2HCAPTCHATURNSTILEnull
technologystringrequired
updatedAtstringrequired
webhookUrlstringrequired
workspaceIdstringrequired
400Returned when the request is malformed or fails validation.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
401Returned when the token is missing, malformed, revoked, or expired.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
403Returned when the token lacks the required scope, the workspace is not upgraded, or a limit was reached.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
404Returned when the resource does not exist.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
429Returned when the caller is rate limited and should retry later.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
500Returned when a server-side error occurs.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired

Error handling

A 400 is returned when the request is malformed or fails validation. A 401 is returned when the token is missing, malformed, revoked, or expired, and a 403 is returned when the token lacks the required scope, the workspace is not upgraded, or a limit was reached. A 404 indicates the form does not exist, a 429 means the caller is rate limited, and a 500 indicates a server-side failure. The formId path parameter must contain at least one character.