queryStaffMembers( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of staff members.

The queryStaffMembers() function builds a query to retrieve a list of staff members and returns a StaffMembersQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining StaffMembersQueryBuilder functions onto the query. StaffMembersQueryBuilder functions enable you to sort, filter, and control the results that queryStaffMembers() returns.

queryStaffMembers() runs with the following StaffMembersQueryBuilder default that you can override:

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

The functions that are chained to staffMembersTypes() are applied in the order they are called.

The following StaffMembersQueryBuilder functions are supported for the queryStaffMembers() function. For a full description of the resource object, see the object returned for the items property in StaffMembersQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
nameeq(),ne(),in(),exists()
emaileq(),ne(),in(),exists()
phoneeq(),ne(),in(),exists()
descriptioneq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
resourceIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
resource.ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
associatedWixIdentity.identificationData.wixUserIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
associatedWixIdentity.identificationData.contactIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
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
optionsQueryStaffMembersOptions
Returns
Did this help?