Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

To use the Forum API, install the `@wix/forum` package using npm or Yarn:
  ```console
npm install @wix/forum
```

or

```console
yarn add @wix/forum
```

Then import `forum` from `@wix/forum`:

```js
import forum from '@wix/forum'
```
  

forum

getCategory

getCategoryBySlug

Returns a list of categories by [query](https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md)

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

queryCategories

To use the Categories API, install the `@wix/forum` package using npm or Yarn:
  ```console
npm install @wix/forum
```

or

```console
yarn add @wix/forum
```

Then import `{ categories }` from `@wix/forum`:

```js
import { categories } from '@wix/forum'
```
  

# 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://dev.wix.com/api/sdk/guides/filter-with-the-api-query-language),
[queryCategories( )](https://dev.wix.com/api/sdk/forum/categories/querycategories)


getPost

getPostBySlug

Returns a list of posts by query.

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

Filterable fields:
- id
- categoryId
- ownerId
- title
- contentText
- bestAnswerCommentId
- pinned
- commentingEnabled
- commentCount
- likeCount
- viewCount
- createdDate
- editedDate
- lastActivityDate
- slug

Sortable fields:
- lastActivityDate
- createdDate
- commentCount
- viewCount
- likeCount
- pinned

queryPosts

To use the Posts API, install the `@wix/forum` package using npm or Yarn:
  ```console
npm install @wix/forum
```

or

```console
yarn add @wix/forum
```

Then import `{ posts }` from `@wix/forum`:

```js
import { posts } from '@wix/forum'
```
  

# Posts: 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`                                  | Sortable |
| `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     |

__Related content:__
[API Query Language](https://dev.wix.com/api/sdk/guides/filter-with-the-api-query-language),
[queryPosts( )](https://dev.wix.com/api/sdk/forum/posts/queryposts)


Posts

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

string

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

order

Order

_createdDate

_updatedDate

Defines what additional reactions may be applied on the comment under the posts created in this category.

additionalCommentReactions

Defines what additional reactions may be applied on the posts created in this category.

additionalPostReactions

Whether all site visitors and members (`PUBLIC`), all members (`MEMBERS_ONLY`), or only specific members and groups of members with roles, badges or paid subscriptions (`PRIVATE`) can access posts in category.

Supported values: `"UNKNOWN"`, `"PUBLIC"`, `"MEMBERS_ONLY"`, `"PRIVATE"`.

categoryAccess

Defines what interactions may be applied on the comment under the posts created in this category.

Supported values: `"REACTION"`, `"VOTE"`.

commentInteraction

Interaction

description

IDs of groups which can access category if `categoryAccess` is `'PRIVATE'`.

groups

headerImage

headerTitle

Category header type.

Supported values: `"NONE"`, `"COLOR"`, `"IMAGE"`.

headerType

HeaderType

Defines which icon will be used for main reaction (like) on the comment under the posts created in this category.

mainCommentReaction

Reaction

Defines which icon will be used for main reaction (like) on the posts created in this category.

mainPostReaction

name

Whether only admins and moderators can write posts in category.

noMemberPosting

boolean

parentId

postCount

Defines what interactions may be applied on the posts created in this category, like or multiple reactions.

postInteraction

PostInteraction

postTypes

postViewCount

The position of the category in the display order.

rank

slug

CategoryResponse

Retrieved category for the provided category ID.

Field

GetCategoryBySlugOptions

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

Supported Values: `"URL"`.

extraFields

GetCategoryOptions

PostType

QueryCategoriesOptions

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

filter

Paging object (e.g., {limit: 10, offset: 100 } )

paging

Array of sort objects (e.g.,  [{ fieldName: rank, order: Order.ASC }] )

sort

QueryCategoriesResponse

metaData

QueryCategoriesResponseMetaData

count

Total number of records that match the filters.

total

type

code

Type

EntityType

GetPostBySlugOptions

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


Supported values: `"IMAGES"`, `"VIDEOS"`, `"URL"`, `"REACTION_IDENTITIES"`.

GetPostOptions

Identity

identityId

identityType

IdentityType

Post

bestAnswerCommentId

categoryId

Whether post is closed and commenting is disabled.

closed

commentCount

Defines what interactions may be applied on the comment under the post.

Supported values: `"REACTION"`, `"VOTE"`.

contentText

images

Date of latest activity on this post. For example, date the latest comment was added to post.

lastActivityDate

likeCount

IDs of the marked comments for this post (selected by forum admin or post owner).

markedComments

ownerId

Whether the post is pinned. Places the post at the top of the post list.

pinned

List of reaction identities grouped by reaction code.

reactionIdentities

Recent activity of post (e.g., activity of the latest comment was added to post).

recentActivity

RecentActivity

title

videos

viewCount

PostResponse

post

PostsPaging

PostsSort

Records can be sorted by:
lastActivityDate
createdDate
commentCount
viewCount
likeCount
isPinned

QueryPostsOptions

Filter object (e.g., { $and: [{ ownerId: { eq: 'ownerId' } }, { likeCount: { $gt: 0 }] } ).

Setup