POST

Query Notes


Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of up to 1,000 notes given the provided filtering, paging, and sorting.

Important: When making the first query request without a cursor, the contactId field is required. For subsequent requests using cursor pagination, contactId becomes optional as the cursor contains the context from the previous query.

By default, notes are sorted by created date in descending order.

Refer to Notes: Supported Filters and Sorting for a complete list of supported filters and sorting options.

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

PropertyFiltersSort
_id$eq, $inNone
type$eq, $in, $ne, $ninNone
contactId$eq, $inNone
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Read Notes
Learn more about app permissions.
Method Declaration
Copy
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?