queryPosts( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Method Declaration
Copy
function queryPosts(options: QueryPostsOptions): Promise<QueryPostsResponse>;
Method Parameters
optionsQueryPostsOptions

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

Returns
Return Type:Promise<QueryPostsResponse>
JavaScript
import { posts } from "@wix/forum"; async function queryPosts(options) { const response = await posts.queryPosts(options); }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?