Formspark Octri Preview
GET/forms/{formId}/templates/{kind}

Retrieve a form's email template

Retrieves an email template associated with a form. Use kind to select the notification template sent to recipients or the autoresponder sent to submitters.

2 parameters
formIdstringrequired
The identifier of the form whose template you want to retrieve. Must contain at least one character.
kindstringrequired
The template type to retrieve: `notification` or `autoresponder`.
Allowed:notificationautoresponder

8 status codes
200Returns the template object with its body, kind, editing mode, paused status, subject, and last-updated timestamp.
codestringrequired
kindstringrequired
Allowed:notificationautoresponder
modestringrequired
Whether the template is laid out in the visual editor or written as code. Writing code to a visual template replaces its layout and cannot be undone.
Allowed:visualcode
pausedbooleanrequired
Whether our content check has stopped this template from sending. A paused notification template sends no notifications at all, and a paused autoresponder template sends no replies. Submissions are still stored either way. Writing the template checks the new version before this response returns.
subjectstringrequired
The subject line as written, placeholders included, or null when the template has none and the email uses the default subject.
updatedAtstringrequired
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 has been reached.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
404Returned when the requested 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 something goes wrong on the service's end.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
503Returned when the template service is unavailable; retry shortly.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired

Error handling

A 400 is returned for malformed requests or validation failures; a 401 is returned when the token is missing, malformed, revoked, or expired; a 403 is returned when the token lacks the required scope, the workspace is not upgraded, or a limit is reached; and a 404 is returned when the resource does not exist. A 429 means the caller is rate limited, a 500 indicates an error on the service's end, and a 503 means the template service is unavailable. The formId path parameter must be at least one character, and the kind path parameter must be notification or autoresponder.