This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Searches for items in a collection on the basis of the filtering, sorting, searching, and paging preferences you provide.
Learn more about API Query Language.
Notes:
Each field type supports a specific set of filter operators. Using a filter operator that's not supported for a given field type causes the search to fail.
| Field Type | Supported Filter Operators |
|---|---|
| Text, Image, Document, URL, Video, Audio, Time, Reference, Page Link, Rich Text, Rich Content, Address | $in, $eq, $ne, $gt, $gte, $lt, $lte, $isEmpty, $startsWith |
| Number, Date, Date and Time | $eq, $ne, $gt, $gte, $lt, $lte, $isEmpty |
| Boolean | $eq, $ne, $isEmpty |
| Array of strings | $hasSome, $hasAll, $isEmpty |
| Array, Document Array, Object, Any, Media Gallery | $isEmpty |
Learn more about data types in Wix Data.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.