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.
Note: For SECRET
groups, only site admins, group admins, and group members can see the list of group members.
function listGroupMembers(
groupId: string,
options: ListGroupMembersOptions,
): Promise<ListGroupMembersResponse>;
Group ID.
Paging options.
import { members } from "wix-groups.v2";
// Sample groupId value: '5213c421-7284-22274-c345-6da37c665231'
async function listGroupMembers(groupId) {
try {
const result = await members.listGroupMembers(groupId, options);
return result;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* members: [
* {
* "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
* "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
* "role": {"value": "ADMIN"}
* },
* {
* "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
* "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
* "role": {"value": "MEMBER"}
* },
* {
* "joinedDate": "Wed Jul 01 2019 11:29:43 GMT+0300"
* "memberId": "6de7e9e1-f242-3a12-5231-f8e1242c8912"
* "role": {"value": "MEMBER"}
* }
* ],
* metadata:
* {
* "count": 3
* "offset": 0
* "tooManyToCount": false
* "total": 3
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.