listGroupMembers( )

Lists all members of a group.

Description

The listGroupMembers() function returns a Promise that resolves to a list of up to 100 group members. Sorts by default to joinedDate in descending order.

Notes:
For SECRET groups, only site admins, group admins, and group members can see the list of group members. However, if the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can see the list of group members.
This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use null as a placeholder for any unspecified parameters. For example, to specify limit only, call listGroupMembers(groupId, paging, null). To specify supressAuth only, call listGroupMembers(groupId, null, options).

Syntax

function listGroupMembers(groupId: string, [paging: Paging], [options: Options]): Promise<ListGroupMembers>

listGroupMembers Parameters

NAME

TYPE

DESCRIPTION

groupId

string

Group ID.

paging

Optional

Paging

Paging options.

options

Optional

Options

Authorization options.

Returns

Return Type:

Promise<ListGroupMembers>

NAME

TYPE

DESCRIPTION

members

Array<GroupMember>

Group members.

metadata

Metadata

Paging information.

Was this helpful?

List all site members in a group

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-backend';
3
4// Sample groupId value:
5// '6355cf94-bd3a-466d-9d61-980bcb7458ea'
6
7export const myListGroupMembersFunction = webMethod(Permissions.Anyone, (groupId) => {
8  return members.listGroupMembers(groupId)
9    .then((groupMembersResults) => { 
10      const groupMembersRole = groupMembersResults.members[0].role;
11      return groupMembersResults;
12    })
13    .catch((error) => {
14      console.error(error);
15    });
16});
17
18/* Promise resolves to:
19 * members: [
20 *  { 
21 *    "role": "ADMIN"
22 *    "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
23 *    "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
24 *  },
25 *  {
26 *    "role": "MEMBER"
27 *    "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
28 *    "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
29 *  }
30 * ],
31 * metadata: 
32 *  {
33 *   "length": 2
34 *   "tooManyToCount": false
35 *   "totalCount": 5
36 *  }
37 */

List all site members in a group using options

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-backend';
3
4// Sample groupId value:
5// '6355cf94-bd3a-466d-9d61-980bcb7458ea'
6//
7// Sample paging value:
8// {
9//   limit: 2,
10//   skip: 1
11// }
12//
13// Sample options value:
14// {
15//   suppressAuth: true
16// }
17
18export const myListGroupMembersFunction = webMethod(Permissions.Anyone, (groupId, paging, options) => {
19  return members.listGroupMembers(groupId, paging, options)
20    .then((groupMembersResults) => { 
21      const groupMembersRole = groupMembersResults.members[0].role;
22      return groupMembersResults;
23    })
24    .catch((error) => {
25      console.error(error);
26    });
27});
28
29/* Promise resolves to:
30 * members: [
31 *  { 
32 *    "role": "ADMIN"
33 *    "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
34 *    "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
35 *  },
36 *  {
37 *    "role": "MEMBER"
38 *    "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
39 *    "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
40 *  }
41 * ],
42 * metadata: 
43 *  {
44 *   "length": 2
45 *   "tooManyToCount": false
46 *   "totalCount": 5
47 *  }
48 */