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
.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
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
name | eq() ,ne() ,in() ,exists() |
email | eq() ,ne() ,in() ,exists() |
phone | eq() ,ne() ,in() ,exists() |
description | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
resourceId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
resource.id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
associatedWixIdentity.identificationData.wixUserId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
associatedWixIdentity.identificationData.contactId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
_createdDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_updatedDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |