POST

Query Posts

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.
Endpoint
POST
https://www.wixapis.com/forum/v1/posts/query
Body Params
pagingPaging

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

filterstruct

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

sortArray <PostsSort>

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

extraFieldsArray <string>

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

Response Object
postsArray <Post>

List of posts.

metaDataMetaData

Pagination.

Query Posts Example 1
Request
cURL
Response
JSON
Errors

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

Did this help?