getCategory( )


Developer Preview

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

Returns a single category by ID.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Method Declaration
Copy
function getCategory(
  categoryId: string,
  options: GetCategoryOptions,
): Promise<Category>;
Method Parameters
categoryIdstringRequired

ID of the retrieved category.


optionsGetCategoryOptions

Options specifying which fields to return.

Returns
Return Type:Promise<Category>
JavaScript
import { categories } from "@wix/forum"; async function getCategory(categoryId, options) { const response = await categories.getCategory(categoryId, options); }
Errors

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

Did this help?