searchStaffMembers( )


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 up to 100 staff members, given the provided filtering, paging, and sorting.

Defaults

Search Staff Members has the following default settings, which you can override:

  • Sorted by createdDate in ascending order.
  • cursorPaging.limit set to 100.

Filter

Refer to the supported filters article (SDK | REST) for a complete list of supported filters and sorting options.

See also

To learn about working with Search methods, see API Query Language (SDK | REST) and Sorting and Paging (SDK | REST).

PropertyCapabilitiesFilters
descriptionSearch: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
emailSearch: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
nameSearch:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
phoneSearch: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
resourceIdSearch: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

Search criteria including filter, sort, and paging options.

See the supported filters article (SDK | REST) for complete filter and sorting options.


optionsSearchStaffMembersOptions
Returns
Return Type:Promise<SearchStaffMembersResponse>
Errors

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

Did this help?