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 members, given the provided filters, fieldsets, sorting and paging, and returns a MembersQueryBuilder
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 MembersQueryBuilder
functions onto the query. MembersQueryBuilder
functions enable you to sort, filter, and control the results that queryMembers()
returns. The functions that are chained to queryMembers()
are applied in the order they are called.
queryMembers()
runs with the following MembersQueryBuilder
defaults that you can override:
skip
: 0
limit
: 50
Currently supported fields for sorting:
profile.nickname
contact.firstName
contact.lastName
createdDate
lastLoginDate
The following MembersQueryBuilder
functions are supported for the queryMembers()
function. For a full description of the Locations object, see the returned for the items
property in MembersQueryResult
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
loginEmail | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
contact.firstName | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
contact.lastName | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
profile.nickname | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
profile.slug | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
privacyStatus | eq() ,ne() ,exists() ,in() ,hasSome() |
Query options.