Retrieves a list of up to 1,000 categories with the specified filtering, sorting, and cursor paging.
Specify supported values in fields to include those fields in the response.
Search Categories has the following default settings, which you can override:
createdDate in descending order.cursorPaging.limit set to 100.When using filters for dates, you must use UTC time.
Refer to the supported filters & sorting table (SDK) or the supported filters article (REST) for a complete list of supported filters and sorting options.
To learn about working with Search methods, see API Query Language (SDK | REST) and Sorting and Paging (SDK | REST).
| Property | Capabilities | Filters |
|---|---|---|
id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
slug | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
treeReference.appNamespace | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
treeReference.treeKey | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
visible | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
managingAppId | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
parentCategory.id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
parentCategory.index | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
description | Search: ✓ Aggregate: ✗ Sort: ✗ |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.