queryCategories( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Method Declaration
Copy
function queryCategories(
  options: QueryCategoriesOptions,
): Promise<QueryCategoriesResponse>;
Method Parameters
optionsQueryCategoriesOptions

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

Returns
Return Type:Promise<QueryCategoriesResponse>
JavaScript
import { categories } from "@wix/forum";

async function queryCategories(options) {
  const response = await categories.queryCategories(options);
}
Errors

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

Did this help?