POST

Query Ribbons

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 up to 100 ribbons, given the provided filtering, sorting, and cursor paging. Pass supported values to the fields array in the request to include those fields in the response.

Query Brands runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100

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

PropertyFiltersSort
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
Permissions
Read ribbons in v3 catalog
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?