queryMemberships( )

Retrieves a list of up to 100 memberships, given the provided paging, sorting and filtering.

Description

Creates a query to retrieve a list of memberships.

Note: Only site admins can query a site member's memberships. Site members can query their memberships. However, if the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships.

The queryMemberships() function builds a query to retrieve a list of all memberships, and returns a MembershipsQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function.

You can refine the query by chaining GroupMembersQueryBuilder functions onto the query. GroupMembersQueryBuilder functions enable you to sort, filter, and control the results that queryMemberships() returns.

The results of the queryMemberships() function are sorted by groupId in descending order.

queryMemberships() runs with this GroupMembersQueryBuilder default, which you can override:

limit(100)

The following GroupMembersQueryBuilder functions are supported for queryMemberships(). For a full description of the Memberships object, see the object returned for the items property in MembershipsQueryResult.

Property	Supported Filters & Sorting
`status`	`eq()`, `ne()`
`role`	`eq()`, `ne()`

Syntax

function queryMemberships(): GroupMembersQueryBuilder

queryMemberships Parameters

This function does not take any parameters.

Returns

A GroupMembersQueryBuilder object that contains the refined query.

Return Type:

GroupMembersQueryBuilder

Was this helpful?

Query a site member's memberships

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-backend';
3
4export const myQueryMembershipsFunction = webMethod(Permissions.Anyone, () => {
5  return members.queryMemberships()
6    .find()
7    .then((results) => {
8      const items = results.items;
9      const firstItem = items[0];
10      const pageSize = results.pageSize;
11      const totalPages = results.totalPages;
12      const totalCount = results.totalCount;
13      const currentPage = results.currentPage();
14      const next = results.next();
15      const previous = results.prev();
16      const hasNext = results.hasNext();
17      const hasPrev = results.hasPrev();
18      const length = results.length;
19
20      return items;
21    })
22    .catch((error) => {
23      console.error(error);
24    });
25});
26
27/* Returns items:
28 * [
29 *  { 
30 *    "groupId": "937cd3db-e9be-4980-93c1-a6d767a11050"
31 *    "status": "JOINED"
32 *    "role": "ADMIN"
33 *  },
34 *  {
35 *    "groupId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
36 *    "status": "PENDING"
37 *    "role": "MEMBER"
38 *  }
39 * ]
40 */