Lists all members of a group.
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:
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.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)
.function listGroupMembers(
groupId: string,
paging: Paging,
options: Options,
): Promise<ListGroupMembers>;
Group ID.
Paging options.
Authorization options.
import { Permissions, webMethod } from "wix-web-module";
import { members } from "wix-groups-backend";
// Sample groupId value:
// '6355cf94-bd3a-466d-9d61-980bcb7458ea'
export const myListGroupMembersFunction = webMethod(
Permissions.Anyone,
(groupId) => {
return members
.listGroupMembers(groupId)
.then((groupMembersResults) => {
const groupMembersRole = groupMembersResults.members[0].role;
return groupMembersResults;
})
.catch((error) => {
console.error(error);
});
},
);
/* Promise resolves to:
* members: [
* {
* "role": "ADMIN"
* "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
* "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
* },
* {
* "role": "MEMBER"
* "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
* "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
* }
* ],
* metadata:
* {
* "length": 2
* "tooManyToCount": false
* "totalCount": 5
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.