> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: wix-groups-backend



## Article: Introduction

## Article Link: https://dev.wix.com/docs/velo/apis/wix-groups-backend/introduction.md

## Article Content:

# Introduction
Use the Groups Backend API to create and manage groups on your site. 
To enable groups backend API functionality for your site, add the [Wix Groups](https://support.wix.com/en/article/wix-groups-adding-and-setting-up-wix-groups) application to your site.
 
The following functionality is available via the wix-groups-backend API: 

+ [Groups](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/introduction.md)
  + [Create](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/create-group.md) a new group. 
  + [Delete](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/delete-group.md) an existing group. 
  + [Get](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/get-group.md) group information by ID. 
  + [Get](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/get-group-by-slug.md) group information by slug. 
  + [List](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/list-groups.md) all groups.
  + [Query](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/query-groups.md) groups. 
  + [Update](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/update-group.md) group information.
+ [CreateRequests](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/create-requests/introduction.md)
  + [Approve](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/create-requests/approve-create-requests.md) requests to create a group. 
  + [List](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/create-requests/list-create-requests.md) requests to create a group. 
  + [Query](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/create-requests/query-create-requests.md) requests to create a group.
  + [Reject](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/create-requests/reject-create-requests.md) requests to create a group. 
+ [JoinRequests](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/join-requests/introduction.md)
  + [Approve](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/join-requests/approve-join-requests.md) requests to join a group. 
  + [List](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/join-requests/list-join-requests.md) requests to join a group. 
  + [Query](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/join-requests/query-join-requests.md) requests to join a group.
  + [Reject](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/join-requests/reject-join-requests.md) requests to join a group. 
+ [Members](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/introduction.md)
  + [Add](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/add-group-members.md) members to a group. 
  + [List](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/list-group-members.md) all members of a group. 
  + [List](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/list-memberships.md) a site member's group memberships. 
  + [Query](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/query-group-members.md) members of a group. 
  + [Query](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/query-memberships.md) a site member's group memberships. 
  + [Remove](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/remove-group-members.md) members of a group. 
+ [Roles](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/introduction.md)
  + [Assign](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/assign-role.md) roles to members of a group. 
  + [Unassign](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/unassign-role.md) roles to members of a group. 

### Group Roles 

+ `Site Admin`: A site owner or site contributor with [admin permissions](https://support.wix.com/en/article/roles-permissions-overview#admin-co-owner).  
+ `Group Member`: A site member belonging to a group. 
+ `Group Admin`: A group member that was assigned the 'group admin' role by either the site admin, or another group admin. The creator of a group is automatically a group admin. The group admin has the same permissions as a `site admin`, but only for the specified group.

### Group Privacy Levels 

+ `PUBLIC`: Site visitors can see the group and its content in the list of groups. Site members can join the group. 
+ `PRIVATE`: Site visitors can see the group in the list of groups, but only group admins and group members can see its content. Site members can request to join the group.
+ `SECRET`: Only group admins and group members can see the group and its content in the list of groups. Site members can only join if invited by group admins or group members. 

### Settings for Typical Use Cases 
#### Site member wants to create a group
+ Site admins determine who can create a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**.
+ If set to site members with admin approval, site members can create a group using the [`createGroup()`](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/groups/create-group.md) function, and the group becomes a `createRequest` with a status of `PENDING`. The site admin either approves or rejects the request to create a group. 
+ If set to all site members, site members can create a group using the `createGroup()` function (no approval required). 
+ If set to only admins, only site admins can create a group using the `createGroup()` function.
+ The default is set to site members with admin approval.
+ **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members can create a group.  
+ When a group is created, the newly created group is added to the Groups List page of your site.

#### Site member wants to join a group
+ To join a group, a site member must have a [public profile](https://support.wix.com/en/article/wix-groups-member-privacy-settings-for-groups).
+ Group admins determine who can join their group by setting their [Group Privacy Levels](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/introduction.md#api-reference_wix-groups-backend_group-privacy-levels).
+ If a group's privacy level is set to `PRIVATE`, a site member can request to join the group on your site's Groups List page.
+ Only site admins or group admins can approve or reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`. 
+ **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can approve or reject site member requests to join a group. 
+ When a site member's request to join the group is approved, the member is added to the group. 
+ If a group's privacy level is set to `PUBLIC`, a site member can join the group (no request necessary). 
+ If a group's privacy level is set to `SECRET`, only site members added by an existing group member can join the group (no request necessary). 
 
#### Group member wants to add a site member to their group
+ 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()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/add-group-members.md) 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 `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can add additional members to a group. 

### Permissions Information   
> **Note:** You can override the permissions below by setting the `suppressAuth` option to `true`. 

|Object|Functions|Permissions
|--|--|---|
|[CreateRequests](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/create-requests/introduction.md)| `approveCreateRequests()`, `listCreateRequests()`, `queryCreateRequests()`, `rejectCreateRequests()`|Site admin 
|[Groups](wix-groups-backend/groups/introduction)| `createGroup()`|Manage in your site's Dashboard
|| `deleteGroup()`, `updateGroup()`|Site admin, group admin
|| `listGroup()`, `getGroup()`, `queryGroup()`|For public & private groups: any site member <br> For secret groups: group members, site admin, group admin
|[JoinRequests](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/join-requests/introduction.md)| `approveJoinRequests()`, `listJoinRequests()`, `queryJoinRequests()`, `rejectJoinRequests()`|Site admin, group admin
|[Members](wix-groups-backend/members/introduction)| `addGroupMembers()`|Manage in your site's Dashboard
|| `removeGroupMembers()`|Site admin, group admin
|| `listGroupMembers()`, `queryGroupMembers()` |For public & private groups: any site member <br> For secret groups: group members, site admin
|| `listMemberships()`, `queryMemberships()`|Site admin
|[Roles](wix-groups-backend/roles/introduction)| `assignRole()`, `unassignRole()`|Site admin, group admin