queryCategories( )

Developer Preview

Returns a list of categories by query

Description

Paging

limit: default - 10, min - 0, max - 100
offset: default - 0, min - 0

Filterable fields:

id
parentId
name
rank
headerTitle
headerType
headerDescription
postCount
postViewCount
slug

Sortable fields:

rank
postCount
postViewCount

Admin Method

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

Authorization

Request

This endpoint does not take any parameters

Response Object

NAME

TYPE

DESCRIPTION

Status/Error Codes

Was this helpful?

queryCategories example

Copy Code

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