> 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

# Method name: getGroupBySlug(slug: string, options: Options)

# Method package: wixGroupsBackend

# Method menu location: wixGroupsBackend --> Groups --> getGroupBySlug

# Method Link: https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/get-group-by-slug.md

# Method Description:

Gets a group by slug.

The `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug.
The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `'https:/example.com/groups/{my-fitness-group}'`, the slug is `'my-fitness-group'`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is 
an autogenerated string of characters, for example, `'https:/example.com/groups/{5D3yTX}'`. 

> **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see a group and its content.



# Method Code Examples:

*** Note: do not assume any prop names or enum values other than the ones in the example.

## Get a group by slug

```javascript
import { Permissions, webMethod } from 'wix-web-module';
import { groups } from 'wix-groups-backend';

// Sample slug value:
// 'my-group-1'
//
// Sample options value:
// {
//   suppressAuth: true
// }

export const myGetGroupbySlugFunction = webMethod(Permissions.Anyone, (slug, options) => {
  return groups.getGroupBySlug(slug, options)
    .then((getGroupBySlugResults) => {
      const getGroupBySlugResultsName = getGroupBySlugResults.name;
      const getGroupBySlugResultsPrivacy = getGroupBySlugResults.privacyStatus;
      return getGroupBySlugResults;
    })
    .catch((error) => {
      console.error(error);
    });
});

/* Promise resolves to:
 * { 
 *   "_id": "fc3df3c1-36b2-4279-8be1-8e72a05a88c8"
 *   "name": "My Group 1"
 *   "slug": "my-group-1"
 *   "description": "Welcome to the group! You can connect with other members, get updates and share videos."
 *   "privacyStatus": "PUBLIC"
 *   "coverImage": {
 *     "imageUrl": "wix:image://v1/229074e348009011fa9f2d292jv~mv2.jpg/orange.jpg#originWidth=200&originHeight=900",
 *     "position": {
 *       "x": 30,
 *       "y": 225
 *     }
 *   }
 *   "memberTitle": "Veterans"
 *   "memberCount": 27
 *   "settings": {
 *     "groupUpdatePostEnabled": true
 *     "membersCanApprove": false
 *     "membersCanInvite": true
 *     "showMemberList": true
 *     "welcomeMemberPostEnabled": true
 *   }
 *   "lastActivityDate": "Sun Sep 26 2021 08:23:23 GMT+0300"
 *   "_createdDate": "Tues January 22 2020 12:56:02 GMT+0300"
 *   "_updatedDate": "Fri October 2 2021 04:56:22 GMT+0300"
 *   "owner": "9ne8e9e1-d050-4c86-9684-e7f231600a34"
 * }
 */
```

---