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 up to 100 staff who are eligible to receive tips, given the provided filtering.
You can only call this method when authenticated as a Wix app or Wix user identity.
Whether to include staff who are only Wix users and not
Bookings staff members
in the response. Setting {"includeWixUsers": true}
returns all tippable
staff, including Bookings staff, site collaborators, or those who are both.
By default, or if you provide {"includeWixUsers": false}
, only Bookings
staff members or those who are both are returned.
Default: false
.
Filters the returned staff by name. If you provide a name as filter, only staff whose names start with the given input are returned. The filter isn't case sensitive.
Max: 500 characters
Filters the returned staff by ID. If you provide a list of IDs as filter, only staff members with exact matching IDs are returned.
Max: 100 IDs
Retrieved staff.
curl -X POST \
'https://www.wixapis.com/tips-staff-service/v1/eligible-staff' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
{
"staff": [
{
"id": "79ee2a33-6937-39a4-ab46-6859171c5ad7",
"name": "Malakah Mada",
"staffMemberId": "79ee2a33-6937-39a4-ab46-6859171c5ad7",
"identificationData": null
},
{
"id": "7ec295cd-120c-3bff-9f43-a7e10c387f02",
"name": "Tiago Melo Correia",
"staffMemberId": "7ec295cd-120c-3bff-9f43-a7e10c387f02",
"identification_data": null
},
{
"id": "bdf56958-d4dd-306e-843c-e1196ed10cf5",
"name": "Cornelia Brandybuck",
"staffMemberId": "bdf56958-d4dd-306e-843c-e1196ed10cf5",
"identificationData": null
}
]
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.