queryGroupMembers( )


Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.

Creates a query to retrieve a list of group members.

Note: For SECRET groups, only site admins, group admins, and group members can query group members.

The queryGroupMembers() function builds a query to retrieve a list of all group members, and returns a GroupMembersQueryBuilder 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 GroupMembersQueryBuilder functions onto the query. GroupMembersQueryBuilder functions enable you to sort, filter, and control the results that queryMembers() returns.

queryGroupMembers() runs with these GroupMembersQueryBuilder defaults, which you can override:

The following GroupMembersQueryBuilder functions are supported for queryGroupMembers(). For a full description of the Members object, see the object returned for the items property in MembersQueryResult.

PropertySupported Filters & Sorting
roleeq(), ne()
joinedDateascending(), descending()
PROPERTYSUPPORTED FILTERS & SORTING
roleeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
joinedDateascending(),descending()
Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Method Declaration
Copy
Method Parameters
groupIdstringRequired

Group ID.

Was this helpful?
Yes
No