Search.../
  1. APIs

getGroupBySlug( )

Gets a group by slug.

Description

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.

Syntax

function getGroupBySlug(slug: string, [options: Options]): Promise<Group>

getGroupBySlug Parameters

NAME
TYPE
DESCRIPTION
slug
string

Part of a group's URL, for example, 'https:/example.com/groups/{my-group-slug}'. Generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, 'https:/example.com/groups/{5D3yTX}'. It is case-sensitive.

options
Optional
Options

Authorization options.

Returns

Return Type:

Promise<Group>
NAME
TYPE
DESCRIPTION
_id
string

Group ID.

name
string

Group name.

slug
string

Part of a group's URL, for example, 'https:/example.com/groups/{my-group-slug}'. Generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, 'https:/example.com/groups/{5D3yTX}'. It is case-sensitive.

description
string

Group description.

privacyStatus
string

Group privacy level. One of:

  • 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 members can see its content. Site members can request to join the group.
  • SECRET: Only 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 other group members.
coverImage
CoverImage

Group cover image.

memberTitle
string

What group members are called. For example, 'Coworkers', 'Friends', or 'Students'.

memberCount
number

Number of members in the group.

settings
GroupSettings

Group settings.

lastActivityDate
Date

Date and time the group was last active. For example, a post or comment.

_createdDate
Date

Date and time the group was created.

_updatedDate
Date

Date and time the group was last updated.

owner
string

Site member ID of the group creator. Defaults to group creator.

Was this helpful?

Get a group by slug

Copy Code
1import { Permissions, webMethod } from 'wix-web-module';
2import { groups } from 'wix-groups-backend';
3

4// Sample slug value:
5// 'my-group-1'
6//
7// Sample options value:
8// {
9//   suppressAuth: true
10// }
11

12export const myGetGroupbySlugFunction = webMethod(Permissions.Anyone, (slug, options) => {
13  return groups.getGroupBySlug(slug, options)
14    .then((getGroupBySlugResults) => {
15      const getGroupBySlugResultsName = getGroupBySlugResults.name;
16      const getGroupBySlugResultsPrivacy = getGroupBySlugResults.privacyStatus;
17      return getGroupBySlugResults;
18    })
19    .catch((error) => {
20      console.error(error);
21    });
22});
23

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