queryRibbons( )


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

For field support for filters and sorting, see Ribbons: Supported Filters and Sorting.

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

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
nameeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
Method Declaration
Copy
Method Parameters
optionsQueryRibbonsOptions
Returns
Errors

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

Did this help?