queryGroupMembers( )

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

Description

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 GroupMembersQueryResult.

Property	Supported Filters & Sorting
`role`	`eq()`, `ne()`
`joinedDate`	`ascending()`, `descending()`

PROPERTY	SUPPORTED FILTERS & SORTING
`role`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`joinedDate`	`ascending()`,`descending()`

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function queryGroupMembers(groupId: string): MembersQueryBuilder

queryGroupMembers Parameters

NAME

TYPE

DESCRIPTION

groupId

string

Group ID.

Returns

Return Type:

MembersQueryBuilder

Was this helpful?

Query members of a group (dashboard page code)

Copy Code

1import { members } from 'wix-groups-v2';
2
3export function myQueryGroupMembersFunction() {
4  return members.queryGroupMembers()
5    .find()
6    .then((queryResults) => {
7      const items = results.items;
8      const firstItem = items[0];
9      const pageSize = results.pageSize;
10      const totalPages = results.totalPages;
11      const totalCount = results.totalCount;
12      const currentPage = results.currentPage();
13      const next = results.next();
14      const previous = results.prev();
15      const hasNext = results.hasNext();
16      const hasPrev = results.hasPrev();
17      const length = results.length;
18
19      return items;
20    })
21    .catch((error) => {
22      console.error(error);
23    });
24}
25
26/* Returns items:
27 * [
28 *  { 
29 *     "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
30 *     "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
31 *     "role": {"value": "ADMIN"}
32 *   },
33 *   {
34 *     "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
35 *     "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
36 *     "role": {"value": "MEMBER"}
37 *   }
38 * ]
39 */

Query members of a group (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-v2';
3
4export const myQueryGroupMembersFunction = webMethod(Permissions.Anyone, () => {
5  return members.queryGroupMembers()
6    .find()
7    .then((queryResults) => {
8      const items = queryResults.items;
9      const firstItem = items[0];
10      const pageSize = queryResults.pageSize;
11      const totalPages = queryResults.totalPages;
12      const totalCount = queryResults.totalCount;
13      const currentPage = queryResults.currentPage();
14      const next = queryResults.next();
15      const previous = queryResults.prev();
16      const hasNext = queryResults.hasNext();
17      const hasPrev = queryResults.hasPrev();
18      const length = queryResults.length;
19
20      return items;
21    })
22    .catch((error) => {
23      console.error(error);
24    });
25});
26
27/* Returns items:
28 * [
29 *  { 
30 *     "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
31 *     "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
32 *     "role": {"value": "ADMIN"}
33 *   },
34 *   {
35 *     "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
36 *     "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
37 *     "role": {"value": "MEMBER"}
38 *   }
39 * ]
40 */
41