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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Read Forums
Manage 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.v2"; async function getCategory(categoryId, options) { try { const result = await categories.getCategory(categoryId, options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

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

Did this help?