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.
Notes:
suppressAuth
option is set to true
, all permissions are overwritten, and all site members (including non-group members) can see a list of a site member's memberships.null
as a placeholder for any unspecified parameters. For example, to specify limit
only, call listMemberships(memberId, paging, null)
. To specify supressAuth
only, call listMemberships(memberId, null, options)
.function listMemberships(
memberId: string,
paging: PagingMemberships,
options: Options,
): Promise<ListMemberships>;
Site member ID.
Paging options.
Authorization options.
import { Permissions, webMethod } from "wix-web-module";
import { members } from "wix-groups-backend";
// Sample memberId value:
// '980bcb7458ea55cf94-bd3a-466d-9'
export const myListMembershipsFunction = webMethod(
Permissions.Anyone,
(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"
* "status": "JOINED"
* "role": "ADMIN"
* },
* {
* "groupId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
* "status": "PENDING"
* "role": "MEMBER"
* }
* ],
* 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.