Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

postId

string

Options specifying which additional fields to return.

options

GetPostOptions

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

async function getPost(postId, options) {
  try {
    const result = await posts.getPost(postId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getPost example for dashboard page code

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

const elevatedGetPost = elevate(posts.getPost);

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


getPost example for exporting from backend code

getPost

Post

slug

GetPostBySlugOptions

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

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


getPostBySlug example for dashboard page code

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

const elevatedGetPostBySlug = elevate(posts.getPostBySlug);

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


getPostBySlug example for exporting from backend code

getPostBySlug

PostResponse

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

QueryPostsOptions

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

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

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


queryPosts example for dashboard page code

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

const elevatedQueryPosts = elevate(posts.queryPosts);

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


queryPosts example for exporting from backend code

queryPosts

QueryPostsResponse

---
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 Posts API allows a site visitor to get and query forum posts.
A post is a piece of writing on a forum by site collaborators. 





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

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

# 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://www.wix.com/velo/reference/api-overview/api-query-language),
[queryPosts( )](https://www.wix.com/velo/reference/wix-forum-v2/posts/queryposts)


velo-deps_wix-forum.v2_posts

AddReactionResponse

reactionCount

number

List of reacted identities grouped by reaction code.

reactionIdentities

CreatePostOptions

post

DeletePostResponse

EntityType

Field

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

extraFields

Identity

identityId

identityType

IdentityType

Interaction

MarkPostsSeenOptions

postsIds

Order

PinPostOptions

The amount of minutes after which the pin will be removed (unpinned)

expiresInMinutes

_createdDate

_updatedDate

categoryId

Whether post is closed and commenting is disabled.

closed

boolean

commentCount

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

commentInteraction

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.

Recent activity of post. For example, a comment added to a post.

recentActivity

RecentActivity

title

videos

viewCount

PostFieldField

PostType

PostsPaging

limit

Number of items to skip in the current sort order.

offset

PostsSort

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

fieldName

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

order

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

queryPosts( )

Permission Scopes