POST

Query Tip Settings


Retrieves a list of up to 100 tip settings, given the provided paging, filtering, and sorting.

Query Tip Settings runs with these defaults, which you can override:

  • cursorPaging.limit is 50.
  • Sorted by id in ascending order.

For field support for filters and sorting, see Tip Settings: Supported Filters and Sorting.

Use UTC time when setting a filter for dates.

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

FieldSupported FiltersSort
id$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
locationId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
paymentTerminalId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
default$eq, $ne, $exists, $in, $anySort: ASC, DESC
allowCustomerTip$eq, $ne, $exists, $in, $anySort: ASC, DESC
allowBusinessTipAtPayment$eq, $ne, $exists, $in, $anySort: ASC, DESC
allowEditDistribution$eq, $ne, $exists, $in, $anySort: ASC, DESC
allowCustomAmount$eq, $ne, $exists, $in, $anySort: ASC, DESC
tipType$eq, $ne, $exists, $in, $anySort: ASC, DESC
Permissions
Manage Bookings
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/tip-settings/v1/tip-settings/query

Errors

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

Did this help?