POST

Query Categories


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 1,000 categories, 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.

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

Learn more about the differences between Query and Search methods.

PropertyFiltersSort
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
slug$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
visible$eq, $ne, $exists, $in, $hasSomeNone
treeReference.appNamespace$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
treeReference.treeKey$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
managingAppId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
parentCategory._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
parentCategory.index$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
Permissions
Read categories
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?