Lists all group memberships of a site member.
The listMemberships()
function returns a Promise that resolves to a list of up to 100 group memberships.
Sorts by default to groupId
in descending order.
Note: Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships.
function listMemberships(
memberId: string,
options: ListMembershipsOptions,
): Promise<ListMembershipsResponse>;
Site member ID.
Paging options.
import { members } from "wix-groups.v2";
// Sample memberId value: '980bcb7458ea55cf94-bd3a-466d-9'
export function myListMembershipsFunction(memberId) {
return members
.listMemberships(memberId)
.then((groupMembershipsResults) => {
const groupMembershipsRole = groupMembershipsResults.memberships[0].role;
return groupMembershipsResults;
})
.catch((error) => {
console.error(error);
});
}
/* Promise resolves to:
* memberships: [
* {
* "groupId": "937cd3db-e9be-4980-93c1-a6d767a11050"
* "role": {"value": "ADMIN"}
* "status": "JOINED"
* },
* {
* "groupId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
* "role": {"value": "MEMBER"}
* "status": "PENDING"
* },
* {
* "groupId": "6de7e9e1-f242-3a12-5231-f8e1242c8912"
* "role": {"value": "MEMBER"}
* "status": "PENDING"
* }
* ],
* 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.