# About the Forum APIs

<blockquote class='warning'>

__Deprecation Notice:__

The Forum APIs will be deprecated on October 15, 2025. To maintain and manage an online community for site members to interact and participate in discussions, use the [Groups API](fallback::https://dev.wix.com/docs/rest/crm/community/groups/introduction). 

Learn more about the migration from [Wix Forums to Wix Groups](fallback::https://support.wix.com/en/article/wix-forum-move-your-forum-to-wix-groups).

</blockquote>

Wix Forum allows Wix users and site members to create and manage forum posts. The posts can be organized in categories.

Learn more [about Wix Forum](fallback::https://support.wix.com/en/article/wix-forum-about-wix-forum).

## Use cases

The Forum API allows you to reuse forum content in a modular fashion.

To set up an automated feed of new posts and sub-forums based on news, events, or other topics so that members and admins don't have to do it manually:
1. Decide criteria for selecting forum posts to display, e.g. based on keywords or listing all categories, and retrieve these categories using [Query Categories](fallback::https://dev.wix.com/docs/rest/business-solutions/forum/category/query-categories).
2. Consume the [Post Created](fallback::https://dev.wix.com/docs/rest/business-solutions/forum/post/post-created) event to get all new posts.
3. Filter the new posts by their `categoryId`, or by keywords found in `contentText`, and link back to them using `url` and `title` to create links.

## Terminology

- **Post:**
  A post written by a site member. Posts can be pinned (set to always appear at the top of a forum page), moved (to a new category), liked/unliked (to show approval, or not), and closed/opened (for replies). These actions happen in the site only, but you can be notified of them using events.

- **Category:**
  A logical group that the site member assigns their post(s) to in the forum.

- **Draft Post:**
  A pending post written by a site member used for post moderation. Draft posts can be approved (they are posted to the forum) or deleted.

# Field Support for Filtering and Sorting

Endpoints that allow for querying follow the [API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).

Note that the `$hasSome` operator works the same as the operator "IN" in SQL.

## Post API: Supported Filters and Sorting

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

| Field               | Supported Filters                            | Sortable  |
| ------------------- | -------------------------------------------- | --------- |
| `id`                | `$eq`, `$ne`, `$hasSome`                    | Sortable  |
| `categoryId`        | `$eq`, `$ne`                                |           |
| `title`             | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome` |           |
| `ownerId`           | `$eq`, `$ne`                                |           |
| `contentText`       | `$eq`, `$ne`, `$contains`, `$hasSome`, `$startsWith`, `$endsWith`, `$hasSome` |           |
| `bestAnswerCommentId`| `$eq`, `$ne`                               |           |
| `pinned`            | `$eq`, `$ne`                                | Sortable   |
| `commentingEnabled` | `$eq`, `$ne`                                |           |
| `commentCount`      | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`  | Sortable  |
| `likeCount`         | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`  | Sortable  |
| `viewCount`         | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`  | Sortable  |
| `createdDate`       | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`  | Sortable  |
| `updatedDate`       | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`  |           |
| `lastActivityDate`  | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`  | Sortable  |
| `slug`              | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome` | Sortable  |

### Examples

**Query pinned posts**

```
curl 'https://www.wixapis.com/forum/v1/posts/query' --data-binary '{"filter": {"pinned": {"$eq": true}}}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

**Get all posts, sorted by created date (latest first)**

```
curl 'https://www.wixapis.com/forum/v1/posts/query' --data-binary '{"sort":[{"fieldName": "createdDate", "order": "DESC"}]}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

**Get posts by IDs**

```
curl 'https://www.wixapis.com/forum/v1/posts/query' --data-binary '{"filter": {"id": {"$hasSome": ["POST_ID_1","POST_ID_2"]}}}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

__Related content:__
[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),
[Query Posts](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d4b5d2b-dcd1-4e90-9d0b-71fc4424c9d6slug::query-posts*fallback::https://dev.wix.com/docs/rest/api-reference/wix-forum/wix-forum/post/query-posts)

## Category API: Supported Filters and Sorting

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

| Field            | Supported Filters                                      | Sortable |
| ---------------- | ------------------------------------------------------ | -------- |
| `id`             | `$in`, `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`    |          |
| `parentId`       | `$in`, `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`    |          |
| `name`           | `$in`, `$eq`, `$ne`                                   |          |
| `rank`           | `$in`, `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`    | Sortable |
| `headerTitle`    | `$in`, `$eq`, `$ne`                                   |          |
| `headerType`     | `$in`, `$eq`, `$ne`                                   |          |
| `headerDescription` | `$in`, `$eq`, `$ne`                                 |          |
| `postCount`      | `$in`, `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`    | Sortable|
| `postViewCount`  | `$in`, `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`    | Sortable |
| `slug`           | `$in`, `$eq`, `$ne`                                   |          |



### Examples

**Query categories by description**

```
curl 'https://www.wixapis.com/forum/v1/categories/query' --data-binary '{"filter": {"description": {"$contains": "cat"}}}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

**Get all categories, sorted by rank**

```
curl 'https://www.wixapis.com/forum/v1/categories/query' --data-binary '{"sort":[{"fieldName": "rank"}]}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

**Get categories by IDs**

```
curl 'https://www.wixapis.com/forum/v1/categories/query' --data-binary '{"filter": {"id": {"$hasSome": ["CATEGORY_ID_1","CATEGORY_ID_2"]}}}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

__Related content:__
[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),
[Query Categories](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c0d2990d-49e1-49c0-8cdd-209d7e624819slug::query-categories*fallback::https://dev.wix.com/docs/rest/api-reference/wix-forum/wix-forum/category/query-categories)

## Draft Post API: Supported Filters and Sorting

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

| Field          | Supported Filters                           | Sortable  |
| -------------- | ------------------------------------------- | --------- |
| `id`           | `$eq`, `$ne`, `$hasSome`                   | Sortable  |
| `categoryId`   | `$eq`, `$ne`                               |           |
| `title`        | `$eq`, `$ne`, `$contains`, `$hasSome`, `$urlized`, `$startsWith`, `$endsWith`, `$hasSome` |           |
| `ownerId`      | `$eq`, `$ne`                               |           |
| `contentText`  | `$eq`, `$ne`, `$contains`, `$hasSome`, `$startsWith`, `$endsWith`, `$hasSome` |           |
| `commentingType` | `$eq`, `$ne`                             |           |
| `createdDate`  | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable  |


### Examples

**Query draft post by content text**

```
curl 'https://www.wixapis.com/forum/v1/draft-posts/query' --data-binary '{"filter": {"contentText": {"$contains": "cat"}}}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

**Get all draft posts, sorted by createdDate**

```
curl 'https://www.wixapis.com/forum/v1/draft-posts/query' --data-binary '{"sort":[{"fieldName": "createdDate"}]}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

**Get draft posts by IDs**

```
curl 'https://www.wixapis.com/forum/v1/draft-posts/query' --data-binary '{"filter": {"id": {"$hasSome": ["DRAFT_POST_ID_1","DRAFT_POST_ID_2"]}}}' -H 'Content-Type: application/json' -H 'Authorization: <AUTH>'
```

__Related content:__
[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language)

# Forum Schema for Wix Search

This article describes the Wix Forum fields you can [search and aggregate](fallback::https://dev.wix.com/docs/rest/business-management/search/wix-site-search/search) on a site.

To search or aggregate Wix Forum content on a site, set the search API `documentType` parameter to `FORUM_CONTENT`. 


### Fields

#### documentType

**Description**: Document type that was searched. In this case, `FORUM_CONTENT`.

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### \_id

**Description**: Post or comment ID.

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### title

**Description**: Post title.

**Type**: String

**Can search the content of this field**: Yes

**Can facet**: No

**Can sort**: No

**Can filter**: in, eq, ne, gt, ge, lt, le

#### description

**Description**: Text of the post or comment.

**Type**: String

**Can search the content of this field**: Yes

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### url

**Description**: Relative URL of the post page on your site. For comments, the URL points to the location of the comment on your post page.

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### image

**Description**: File source of the post image.

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### contentType

**Description**: Indicates whether the document is a post or a comment. Value can be "POST" or "COMMENT".

**Type**: String

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: No

**Can filter**: eq, ne

#### postId

**Description**: ID of the post the comment is associated with. Only relevant for comments.

**Type**: String 

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le 

#### ownerId

**Description**: Unique ID of the site visitor who posted the post or comment.

**Type**: String 

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le 

#### categoryId

**Description**: ID of the category associated with the post.

**Type**: String

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: No

**Can filter**: in, eq, ne, gt, ge, lt, le 

#### hashTags

**Description**: Hashtags in the post.

**Type**: Array of Strings

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: No

**Can filter**: hasSome, hasAll

#### lastActivityDate

**Description**: Date and time of the last action performed on the post or comment.

**Type**: Date

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le 

#### likeCount

**Description**: Number of likes the post or comment received.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### viewCount

**Description**: Number of views the post received.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### totalComments 

**Description**: Number of comments the post received.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### postTitle

**Description**: Title of the post. Only relevant for posts.

**Type**: String

**Can search the content of this field**: Yes

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### categoryTitle

**Description**: Title of the category.

**Type**: String

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### parentId

**Description**: ID of the parent comment.

**Type**: String

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### createdDate

**Description**: Date and time the comment or post was created.

**Type**: Date

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: eq, ne, gt, ge, lt, le

#### upvoteCount

**Description**: Number of upvotes on the comment.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### downvoteCount

**Description**: Number of downvotes on the comment.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### score

**Description**: Number of upvotes minus the number of downvotes.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### editedDate

**Description**: Date and time the comment or post was last edited.

**Type**: Date

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: Yes

**Can filter**: eq, ne, gt, ge, lt, le

#### mentions

**Description**: Users mentioned in the post.

**Type**: Array of strings

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### markedComments

**Description**: IDs of the marked comments for the post (selected by forum admin or site owner).

**Type**: Array of Strings

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### marked

**Description**: Whether the comment is marked.

**Type**: Boolean

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le

#### commentInteraction

**Description**: Defines what interaction may be applied on the comment.

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### images

**Description**: Images from the post content.

**Type**: Nested

**Can search the content of this field**: No

**Can filter**: No

**Nested fields**:

#### images.id

**Description**: WixMedia image ID (nested under `images`).

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### images.url

**Description**: URL of the image (nested under `images`).

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### images.height

**Description**: Original height of the image (nested under `images`).

**Type**: Number

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### images.width

**Description**: Original width of the image (nested under `images`).

**Type**: Number

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: No

**Can filter**: No

#### reactionsCount

**Description**: Number of reactions.

**Type**: Number

**Can search the content of this field**: No

**Can facet**: Yes

**Can sort**: Yes

**Can filter**: hasSome, hasAll, eq, ne, gt, gte, lt, lte, exists

#### postType

**Description**: Type of post.

**Type**: String

**Can search the content of this field**: No

**Can facet**: No

**Can sort**: Yes

**Can filter**: in, eq, ne, gt, ge, lt, le