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.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Method Declaration
Copy
Method Parameters
groupIdstringRequired

ID of the group to retrieve.


optionsGetGroupOptions
Returns
Return Type:Promise<Group>
Was this helpful?
Yes
No