getGroup( )
Gets a group by ID.
Description
The getGroup()
function returns a Promise that resolves to a group whose ID matches the given ID.
Note: For
SECRET
groups, only site admins, group admins, and group members can see a group and its content. However, if thesuppressAuth
option is set totrue
, all permissions are overwritten, and all site members (including non-group members) can see a group and its content.
Syntax
function getGroup(groupId: string, [options: Options]): Promise<Group>
getGroup Parameters
NAME
TYPE
DESCRIPTION
ID of requested group.
Authorization options.
Returns
Return Type:
NAME
TYPE
DESCRIPTION
Group ID.
Group name.
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.
Group description.
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.
Group cover image.
What group members are called. For example, 'Coworkers', 'Friends', or 'Students'.
Number of members in the group.
Group settings.
Date and time the group was last active. For example, a post or comment.
Date and time the group was created.
Date and time the group was last updated.
Site member ID of the group creator. Defaults to group creator.
Was this helpful?
Get a group by ID
1import { Permissions, webMethod } from 'wix-web-module';2import { groups } from 'wix-groups-backend';34// Sample groupId value:5// 'fc3df3c1-36b2-4279-8be1-8e72a05a88c8'6//7// Sample options value:8// {9// suppressAuth: true10// }1112export const myGetGroupFunction = webMethod(Permissions.Anyone, async (groupId, options) => {13 try {14 const getGroupResults = await groups.getGroup(groupId, options);15 const getGroupResultsName = getGroupResults.name;16 const getGroupResultsDescription = getGroupResults.description;17 return getGroupResults;18 } catch (error) {19 console.error(error);20 }21});2223/* Promise resolves to:24 * {25 * "_id": "fc3df3c1-36b2-4279-8be1-8e72a05a88c8"26 * "name": "My Group 1"27 * "slug": "my-group-1"28 * "description": "Welcome to the group! You can connect with other members, get updates and share videos."29 * "privacyStatus": "PUBLIC"30 * "coverImage": {31 * "imageUrl": "wix:image://v1/ff9074e348009011fa9f2d2961b~mv2.jpg/oak.jpg#originWidth=400&originHeight=900",32 * "position": {33 * "x": 19,34 * "y": 22035 * }36 * }37 * "memberTitle": "Veterans"38 * "memberCount": 5039 * "settings": {40 * "groupUpdatePostEnabled": true41 * "membersCanApprove": false42 * "membersCanInvite": true43 * "showMemberList": true44 * "welcomeMemberPostEnabled": true45 * }46 * "lastActivityDate": "Sun Sep 26 2021 08:23:23 GMT+0300"47 * "_createdDate": "Tues January 22 2020 12:56:02 GMT+0300"48 * "_updatedDate": "Fri October 2 2021 04:56:22 GMT+0300"49 * "owner": "9ne8e9e1-d050-4c86-9684-e7f231600a34"50 * }51 */