listMemberships( )

Lists all group memberships of a site member.

Description

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:
Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships. However, if the 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.
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 listMemberships(memberId, paging, null). To specify supressAuth only, call listMemberships(memberId, null, options).

Syntax

function listMemberships(memberId: string, [paging: PagingMemberships], [options: Options]): Promise<ListMemberships>

listMemberships Parameters

NAME

TYPE

DESCRIPTION

memberId

string

Site member ID.

paging

Optional

PagingMemberships

Paging options.

options

Optional

Options

Authorization options.

Returns

Return Type:

Promise<ListMemberships>

NAME

TYPE

DESCRIPTION

memberships

Array<Membership>

Site member's memberships.

metadata

Metadata

Paging information.

Was this helpful?

List all group memberships of a site member

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-backend';
3
4// Sample memberId value:
5// '980bcb7458ea55cf94-bd3a-466d-9'
6
7export const myListMembershipsFunction = webMethod(Permissions.Anyone, (memberId) => {
8  return members.listMemberships(memberId)
9    .then((groupMembershipsResults) => {
10      const groupMembershipsRole = groupMembershipsResults.memberships[0].role;
11      return groupMembershipsResults;
12    })
13    .catch((error) => {
14      console.error(error);
15    });
16});
17
18/* Promise resolves to:
19 * memberships: [
20 *  { 
21 *    "groupId": "937cd3db-e9be-4980-93c1-a6d767a11050"
22 *    "status": "JOINED"
23 *    "role": "ADMIN"
24 *  },
25 *  {
26 *    "groupId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
27 *    "status": "PENDING"
28 *    "role": "MEMBER"
29 *  }
30 * ],
31 * metadata: 
32 *  {
33 *   "length": 2
34 *   "tooManyToCount": false
35 *   "totalCount": 5
36 *  }
37 */

List all group memberships of a site member using options

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-backend';
3
4// Sample memberId value:
5// '980bcb7458ea55cf94-bd3a-466d-9'
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 myListMembershipsFunction = webMethod(Permissions.Anyone, (memberId, paging, options) => {
19  return members.listMemberships(memberId, paging, options)
20    .then((groupMembershipsResults) => {
21      const groupMembershipsRole = groupMembershipsResults.memberships[0].role;
22      return groupMembershipsResults;
23    })
24    .catch((error) => {
25      console.error(error);
26    });
27});
28
29/* Promise resolves to:
30 * memberships: [
31 *  { 
32 *    "groupId": "937cd3db-e9be-4980-93c1-a6d767a11050"
33 *    "status": "JOINED"
34 *    "role": "ADMIN"
35 *  },
36 *  {
37 *    "groupId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
38 *    "status": "PENDING"
39 *    "role": "MEMBER"
40 *  }
41 * ],
42 * metadata: 
43 *  {
44 *   "length": 2
45 *   "tooManyToCount": false
46 *   "totalCount": 5
47 *  }
48 */