> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListTippableStaff # Package: tips # Namespace: TipStaffService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/other-services/tips/tippable-staff/list-tippable-staff.md ## Permission Scopes: Manage Bookings: SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS ## Introduction Retrieves a list of up to 100 staff who are eligible to receive tips, given the provided filtering. --- ## REST API ### Schema ``` Method: listTippableStaff Description: Retrieves a list of up to 100 staff who are eligible to receive tips, given the provided filtering. URL: https://www.wixapis.com/v1/eligible-staff Method: GET Method parameters: query param name: filterByIds | type: array | description: Filters the returned staff by GUID. If you provide a list of GUIDs as filter, only staff members with exact matching GUIDs are returned. Max: 100 GUIDs query param name: filterByName | type: filterByName | description: 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 query param name: includeWixUsers | type: includeWixUsers | description: Whether to include staff who are only Wix users and not Bookings staff members ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/staff-member-object.md)) 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`. Return type: ListTippableStaffResponse - name: staff | type: array | description: Retrieved staff. - name: id | type: string | description: Staff GUID. Matches `staffMemberId` if available, or `identificationData.wixUserId` if not. - name: name | type: string | description: Staff name. Matches the name of the Bookings staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/staff-member-object.md)), if available. - name: staffMemberId | type: string | description: Staff member GUID. Available only if the staff is connected to a Bookings staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/staff-member-object.md)). - name: identificationData | type: IdentificationData | description: Identification data of the staff. Available only if the staff is a [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site). - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor who hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site visitor who has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user. For example, the site owner or a [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site). - name: appId | type: string | description: GUID of an app. - name: contactId | type: string | description: GUID of the contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. See the Contacts API for additional details. ``` ### Examples ### List tippable staff without filters ```curl curl -X POST \ 'https://www.wixapis.com/tips-staff-service/v1/eligible-staff' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ ``` ### List tippable staff with a name filter ```curl curl -X POST \ 'https://www.wixapis.com/tips-staff-service/v1/eligible-staff' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "filterByName": "john" }' ``` ### List tippable staff including site collaborators ```curl curl -X POST \ 'https://www.wixapis.com/tips-staff-service/v1/eligible-staff' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "includeWixUsers": true }' ``` ### List tippable staff with an ID filter ```curl curl -X POST \ 'https://www.wixapis.com/tips-staff-service/v1/eligible-staff' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "filterByIds": [ "f0f6ac6b-8380-3e85-957c-c315d5b4b0b1" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.tips.TipStaffService.listTippableStaff(options) Description: Retrieves a list of up to 100 staff who are eligible to receive tips, given the provided filtering. Method parameters: param name: options | type: ListTippableStaffOptions none - name: includeWixUsers | type: boolean | description: Whether to include staff who are only Wix users and not Bookings staff members ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/staff-member-object.md)) 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`. - name: filterByName | type: string | description: 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 - name: filterByIds | type: array | description: Filters the returned staff by GUID. If you provide a list of GUIDs as filter, only staff members with exact matching GUIDs are returned. Max: 100 GUIDs Return type: PROMISE - name: staff | type: array | description: Retrieved staff. - name: _id | type: string | description: Staff GUID. Matches `staffMemberId` if available, or `identificationData.wixUserId` if not. - name: name | type: string | description: Staff name. Matches the name of the Bookings staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/staff-member-object.md)), if available. - name: staffMemberId | type: string | description: Staff member GUID. Available only if the staff is connected to a Bookings staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/staff-member-object.md)). - name: identificationData | type: IdentificationData | description: Identification data of the staff. Available only if the staff is a [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site). - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor who hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site visitor who has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user. For example, the site owner or a [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site). - name: appId | type: string | description: GUID of an app. - name: contactId | type: string | description: GUID of the contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. See the Contacts API for additional details. ``` ### Examples ### listTippableStaff ```javascript import { tippableStaff } from '@wix/ecom'; async function listTippableStaff(options) { const response = await tippableStaff.listTippableStaff(options); }; ``` ### listTippableStaff (with elevated permissions) ```javascript import { tippableStaff } from '@wix/ecom'; import { auth } from '@wix/essentials'; async function myListTippableStaffMethod(options) { const elevatedListTippableStaff = auth.elevate(tippableStaff.listTippableStaff); const response = await elevatedListTippableStaff(options); } ``` ### listTippableStaff (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { tippableStaff } from '@wix/ecom'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { tippableStaff }, // Include the auth strategy and host as relevant }); async function listTippableStaff(options) { const response = await myWixClient.tippableStaff.listTippableStaff(options); }; ``` ---