POST

Query Forms


Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of form schemas, based on the specified paging, filtering, and sorting.

Set namespace to the app that owns the forms, wix.form_app.form for the Wix Forms app. A first-page query without a namespace fails with namespace filter is required. A request for a later page needs only the cursor.

For example, to get the first 100 of a site's forms, send {"namespace": "wix.form_app.form", "query": {"cursorPaging": {"limit": 100}}}. When metadata.hasNext is true, send {"query": {"cursorPaging": {"cursor": "<metadata.cursors.next>"}}} for the next page.

PropertyFiltersSort
_id$eq, $in, $ne, $ninSort: ASC, DESC
namespace$eqSort: ASC, DESC
_createdDate$eq, $gt, $gte, $in, $lt, $lte, $ne, $ninSort: ASC, DESC
_updatedDate$eq, $gt, $gte, $in, $lt, $lte, $ne, $ninSort: ASC, DESC
name$eq, $ne, $nin, $in, $startsWithSort: ASC, DESC
enabled$eq, $neSort: ASC, DESC
tags.privateTags.tagIds$hasAll, $hasSomeSort: ASC, DESC
Permission Scopes
View Forms
Learn more about app permissions.
Method Declaration
Copy
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?