POST

Search Categories


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.

Defaults

Search Categories has the following default settings, which you can override:

  • Sorted by createdDate in descending order.
  • cursorPaging.limit set to 100.

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

Learn more about the differences between Query and Search methods.

PropertyCapabilitiesFilters
idSearch: ✗
Aggregate: ✓
Sort: ✗
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
slugSearch: ✗
Aggregate: ✓
Sort: ✗
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
treeReference.appNamespaceSearch: ✗
Aggregate: ✓
Sort: ✗
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
treeReference.treeKeySearch: ✗
Aggregate: ✓
Sort: ✗
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
visibleSearch: ✗
Aggregate: ✓
Sort: ✗
$eq, $ne, $in, $exists
createdDateSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte
updatedDateSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte
managingAppIdSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
nameSearch: ✓
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
parentCategory.idSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
parentCategory.indexSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte
descriptionSearch: ✓
Aggregate: ✗
Sort: ✗
Permission Scopes
Read categories
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/categories/v1/categories/search

Errors

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

Did this help?