getGroup( )


Gets a group by ID.

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 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 Declaration
Copy
function getGroup(groupId: string, options: Options): Promise<Group>;
Method Parameters
groupIdstringRequired

ID of requested group.


optionsOptions

Authorization options.

Returns
Return Type:Promise<Group>
Get a group by ID
JavaScript
import { Permissions, webMethod } from "wix-web-module"; import { groups } from "wix-groups-backend"; // Sample groupId value: // 'fc3df3c1-36b2-4279-8be1-8e72a05a88c8' // // Sample options value: // { // suppressAuth: true // } export const myGetGroupFunction = webMethod( Permissions.Anyone, async (groupId, options) => { try { const getGroupResults = await groups.getGroup(groupId, options); const getGroupResultsName = getGroupResults.name; const getGroupResultsDescription = getGroupResults.description; return getGroupResults; } 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/ff9074e348009011fa9f2d2961b~mv2.jpg/oak.jpg#originWidth=400&originHeight=900", * "position": { * "x": 19, * "y": 220 * } * } * "memberTitle": "Veterans" * "memberCount": 50 * "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" * } */
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?