Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

categoryId

string

Options specifying which fields to return.

options

GetCategoryOptions

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
  }
}


getCategory example for dashboard page code

import { categories } from 'wix-forum.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedGetCategory = elevate(categories.getCategory);

export const getCategory = webMethod(
  Permissions.Anyone,
  async (categoryId, options) => {
    try {
      const result = await elevatedGetCategory(categoryId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getCategory example for exporting from backend code

getCategory

slug

GetCategoryBySlugOptions

import { categories } from 'wix-forum.v2';

async function getCategoryBySlug(slug, options) {
  try {
    const result = await categories.getCategoryBySlug(slug, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getCategoryBySlug example for dashboard page code

import { categories } from 'wix-forum.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedGetCategoryBySlug = elevate(categories.getCategoryBySlug);

export const getCategoryBySlug = webMethod(
  Permissions.Anyone,
  async (slug, options) => {
    try {
      const result = await elevatedGetCategoryBySlug(slug, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getCategoryBySlug example for exporting from backend code

getCategoryBySlug

CategoryResponse

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

QueryCategoriesOptions

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](https://dev.wix.com/docs/rest/api-reference/wix-forum/wix-forum/filter-and-sort#category-api-supported-filters-and-sorting).

To learn about working with _Query_ endpoints, see
[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
[Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging),
and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).

import { categories } from 'wix-forum.v2';

async function queryCategories(options) {
  try {
    const result = await categories.queryCategories(options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


queryCategories example for dashboard page code

import { categories } from 'wix-forum.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedQueryCategories = elevate(categories.queryCategories);

export const queryCategories = webMethod(
  Permissions.Anyone,
  async (options) => {
    try {
      const result = await elevatedQueryCategories(options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


queryCategories example for exporting from backend code

queryCategories

QueryCategoriesResponse

SubscribeContactToCategoryOptions

Subscribes a contact to a specific forum category.

By default a contact isn't subscribed to any forum categories.

By subscribing a contact to a category, the contact receives notifications for that category.

If `contactId` is not provided, it is implicitly resolved from the caller's context.

import { categories } from 'wix-forum.v2';

async function subscribeContactToCategory(categoryId, options) {
  try {
    const result = await categories.subscribeContactToCategory(categoryId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


subscribeContactToCategory example for dashboard page code

import { categories } from 'wix-forum.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedSubscribeContactToCategory = elevate(categories.subscribeContactToCategory);

export const subscribeContactToCategory = webMethod(
  Permissions.Anyone,
  async (categoryId, options) => {
    try {
      const result = await elevatedSubscribeContactToCategory(categoryId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


subscribeContactToCategory example for exporting from backend code

subscribeContactToCategory

void

UnsubscribeContactFromCategoryOptions

Unsubscribes a contact from a specific forum category.


By default a contact isn't subscribed to any forum categories.

By unsubscribing a contact from a category, the contact won’t receive notifications for that category.

If `contactId` is not provided, it is implicitly resolved from the caller's context.

import { categories } from 'wix-forum.v2';

async function unsubscribeContactFromCategory(categoryId, options) {
  try {
    const result = await categories.unsubscribeContactFromCategory(categoryId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


unsubscribeContactFromCategory example for dashboard page code

import { categories } from 'wix-forum.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedUnsubscribeContactFromCategory = elevate(categories.unsubscribeContactFromCategory);

export const unsubscribeContactFromCategory = webMethod(
  Permissions.Anyone,
  async (categoryId, options) => {
    try {
      const result = await elevatedUnsubscribeContactFromCategory(categoryId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


unsubscribeContactFromCategory example for exporting from backend code

unsubscribeContactFromCategory

---
title: Introduction
---

# Introduction

&nbsp;

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>

&nbsp;


The Categories API allows a site visitor to get and query forum categories.
Categories allow you to sort your forum posts into different groups. They give your 
readers a general idea of what your forum posts are about. 





To use the Categories API, import `{ categories }` from the `wix-forum.v2` module:

```javascript
import { categories } from 'wix-forum.v2';
```

# Categories: Supported Filters and Sorting

The following table shows field support for filters and sorting
for the Category object:

| Field           | Supported Filters                             | Sortable |
| --------------- | --------------------------------------------- | -------- |
| `id`            | `$eq`, `$ne`, `$hasSome`                      | Sortable |
| `parentId`      | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	   |  |
| `name`          | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	  |          |
| `rank`          | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`	  | Sortable |
| `headerTitle`   | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	 |  |
| `headerType`    | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	|          |
| `description`   | `$eq`, `$ne`, `$contains`, `$hasSome`, `$startsWith`, `$endsWith`, `$hasSome`   |          |
| `postCount`     | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	   | Sortable |
| `postViewCount` | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	 | Sortable |
| `slug`          | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome`	 |          |

__Related content:__
[API Query Language](https://www.wix.com/velo/reference/api-overview/api-query-language),
[queryCategories( )](https://www.wix.com/velo/reference/wix-forum-v2/categories/querycategories)


velo-deps_wix-forum.v2_categories

Access

CategoriesPaging

limit

number

Number of items to skip in the current sort order.

offset

CategoriesSort

Records can be sorted by:
rank
postCount
postViewCount

fieldName

Records can be sorted in ascending (default) or descending order.

order

Order

CategoryFieldField

ColorComponent

color

opacity

CommentOrder

CreateCategoryOptions

DeleteCategoryResponse

Field

Array of extra category fields to be included in the response.

extraFields

HeaderType

Interaction

Keyword

Whether the keyword is the main focus keyword.

isMain

boolean

term

MarkAllPostsAsReadOptions

PostInteraction

PostType

Filter object (e.g., { $and: [{ postViewCount: { $gt: 0 } }, { postCount: { $gt: 0 }] } )

subscribeContactToCategory( )