POST

Query Messages

Developer Preview

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

Retrieves a list of messages, given the provided paging, filtering, and sorting.

Query messages runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • paging.limit is 50
  • paging.offset is 0

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Supported Filters and Sorting

FieldSupported FiltersSortable
idAll operators.Sortable
createdDateAll operators.Sortable
Authentication

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

Permissions
Manage Bookings Services and Settings
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/wix-assistant-playground/v2/messages/query
Body Params
queryQuery

WQL expression.

Response Object
messagesArray <Message>maxItems 1000

List of messages.

pagingMetadataPagingMetadata

Paging metadata.

Errors

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

Did this help?