Introduction

The Members API provides functionality for managing group members, inluding adding, removing, and querying group members.

Settings for a typical use case

• If a group's privacy level is set to SECRET, group admins or group members can add additional members to their group.
• If a group's privacy level is set to PUBLIC or PRIVATE, group admins determine whether group members can add additional members to their group.
• This setting can be found in your site's Dashboard under Groups Application > Your Group > Admin Tools > Member Permissions.
• If set to all members, group members can add additional members to the group using the addGroupMembers() function (no approval required).
• If set to admins only, only admins can add additional members to the group using the addGroupMembers() function.
• The default is set to admins only.
• Note: If the wix-auth elevate() function is used, all permissions are overridden, and all site members (including non-group members) can add additional members to a group.

The Members API provides functionality allowing you to:

• Add members to a group.
• List all members of a group.
• List a site member's group memberships.
• Query members of a group.
• Query a site member's group memberships.
• Remove members of a group.

Permissions information

Permission requirements for the functions in this API can be overridden using the wix-auth elevate() function. This will have the following effects:

• addGroupMembers() - All site members (including non-group members) can add additional members to a group.
• listGroupMembers() - All site members (including non-group members) can see the list of group members.
• listMemberships() - All site members (including non-group members) can see a list of a site member's memberships.
• queryGroupMembers() - All site members (including non-group members) can query group members.
• queryMemberships() - All site members (including non-group members) can query a site member's memberships.
• removeGroupMembers() - All site members (including non-group members) can remove members from a group.

To use the Members API, import members from the wix-groups-v2 module: