queryMemberships( )

Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.

Description

The queryMemberships function returns a Promise that resolves to a list of memberships.

Note: Site members can only query their own memberships.

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

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function queryMemberships(memberId: string, options: QueryMembershipsOptions): Promise<QueryMembershipsResponse>

queryMemberships Parameters

NAME

TYPE

DESCRIPTION

memberId

string

Site member ID.

options

Optional

QueryMembershipsOptions

Returns

Return Type:

Promise<

QueryMembershipsResponse

NAME

TYPE

DESCRIPTION

memberships

Array<

Membership

Site member's memberships.

metadata

PagingMetadata

Paging information.

Was this helpful?

queryMemberships example

Copy Code

1import { members } from 'wix-groups.v2';
2  
3 async function queryMemberships(memberId, options) {
4   try {
5     const result = await members.queryMemberships(memberId, options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13