POST

Query Tip Settings


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 tip 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.

Permissions
Manage Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/tip-settings/v1/tip-settings/query

Body Params
queryQueryRequired

WQL expression

Response Object
tipSettingsArray <TipSettings>

Retrieved tipSettings objects.


pagingMetadataPagingMetadata

Metadate for the paged set of retrieved tipSettings objects.

Query tip settings
Request
cURL
curl -X POST \ 'https://www.wixapis.com/tip-settings/v1/tip-settings/query' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \
Response
JSON
{ "tipSettings": [ { "id": "1338729c-7255-48f1-a66e-f6a8e4b6f9f3", "tipType": "PERCENTAGE", "presets": [ { "value": 5, "default": true }, { "value": 10, "default": null }, { "value": 15, "default": null } ], "allowCustomerTip": false, "allowBusinessTipAtPayment": true, "allowCustomAmount": true, "staffDistributionMethod": "PROPORTIONAL", "revision": "1", "createdDate": "2024-09-23T08:16:35.039Z", "updatedDate": "2024-09-23T08:16:35.039Z", "default": false, "appId": null, "extendedFields": null } ], "pagingMetadata": { "count": 1, "hasNext": false } }
Errors

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

Did this help?