getCategory( )

Developer Preview

Returns a single category by ID.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function getCategory(categoryId: string, options: GetCategoryOptions): Promise<CategoryResponse>

getCategory Parameters

NAME

TYPE

DESCRIPTION

categoryId

string

ID of the retrieved category.

options

Optional

GetCategoryOptions

Options specifying which fields to return.

Returns

Return Type:

Promise<

CategoryResponse

NAME

TYPE

DESCRIPTION

getCategory example

Copy Code

1import { categories } from 'wix-forum.v2';
2  
3 async function getCategory(categoryId, options) {
4   try {
5     const result = await categories.getCategory(categoryId, options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13