queryCategories( )


Deprecated

This method is deprecated.

Retrieves a list of categories, given the provided paging, filtering, and sorting.

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

  • paging.limit is 10
  • paging.offset is 0

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

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

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Read Forums
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryCategoriesOptions

Options for sorting, filtering, paging, and specifying return fields.

Returns
Return Type:Promise<QueryCategoriesResponse>
Errors

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

Did this help?