POST

Query Submissions By Namespace

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.

Note: The Form Submission API only works with the Wix Forms app. Call GetAppInstance to confirm that the app named wix_forms is installed on the site.

Returns a list of up to 100 submissions, based on the specified paging, filtering, and sorting.

Every query must filter by namespace, and the namespace must be inside query.filter. For the Wix Forms app, the namespace is wix.form_app.form. The API ignores a namespace sent anywhere else, such as at the top level of the request body beside query, and the call fails with namespace filter is required.

For example, to get the latest submissions of a form, send {"query": {"filter": {"namespace": "wix.form_app.form", "formId": "<formId>"}, "sort": [{"fieldName": "createdDate", "order": "DESC"}], "cursorPaging": {"limit": 100}}}.

The submission time is createdDate. Filter and sort by createdDate and updatedDate, not by _createdDate or _updatedDate.

For the fields you can filter and sort by, see Form Submissions: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Property	Filters	Sort
`_id`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`formId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`contactId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`namespace`	`$eq`	None
`status`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`seen`	`$eq`, `$ne`	Sort: `ASC`, `DESC`
`_createdDate`	`$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`_updatedDate`	`$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`submitter.memberId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`submitter.visitorId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`submitter.applicationId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`submitter.userId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`orderDetails.checkoutId`	`$eq`, `$in`, `$ne`, `$nin`	Sort: `ASC`, `DESC`
`childMetaSiteId`	`$eq`, `$in`, `$ne`, `$nin`	None

Permission Scopes

Learn more about app permissions.

Method Declaration

Copy

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?