About the Form Templates API

The Form Templates API lets you retrieve form templates. A form template is a reusable definition of a form, including its fields, steps, and settings, that's used as the source when creating a form on a Wix site.

With the Form Templates API, you can retrieve the templates published for a namespace and use them to present ready-made forms to users or to seed new forms.

Templates are authored by app owners in the app dashboard: any Wix vertical can build an app and define templates for its namespace. To turn a template into an editable form on a site, pass the template's fields and steps to Create Form in the Form Schemas API.

Namespaces

Every template belongs to a namespace. A namespace groups all templates and forms that belong to the same app or use case, such as a bookings or pricing plans checkout. The namespace value is defined by the app that owns the templates, and it's the value you pass to List Form Templates. For example, the Wix Forms app uses the namespace wix.form_app.form.

The following table lists the namespaces of some apps made by Wix:

App name	Namespace
Wix Pricing Plans	wix.pricing_plans.v1.custom_form
Wix Forms	wix.form_app.form
Wix eCommerce	wix.ecom.v1.checkout
Wix Quizzes	wix.achievements.quizzes.v1.quiz
Wix Bookings	wix.bookings.v2.bookings
Wix Contacts	wix.contacts.v4.contact

Before you begin

It's important to note the following points before starting to code:

• This API is read-only. App owners define templates in the app dashboard, and templates can't be created, updated, or deleted through the API.
• Templates for a namespace are returned only when the app that owns it is installed on the site. Apps made by Wix are always available.
• Template content is returned in the language resolved from the request.

Use cases

• Offer users a gallery of starter templates
• Let a user start their own form from a template
• Retrieve specific templates your app relies on

Terminology

• Form template: A reusable definition of a form, including its fields, steps, and settings, used as the source when creating a form.
• Namespace: A unique identifier that groups templates and forms belonging to the same app or use case.
• Form field: An individual input or display element within a template, such as a text input, an email input, or a submit button.
• Step: A page of the form. Each step's layout places fields by referencing their IDs.
• Field group: A set of related fields gathered under a shared label on the form's layout.