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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Read Forums
Manage Forums
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryPostsOptions

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

Returns
Return Type:Promise<QueryPostsResponse>
Did this help?