Skip to main content
Groups allow you to organize members within a space around specific topics, courses, or interests. This guide covers creating groups and managing their membership.

​
Understanding Groups

Groups are sub-communities within a space that enable:
  • Focused discussions around specific topics
  • Course or subject-based organization
  • Targeted content sharing
  • Granular permission management

​
Group Structure

{
  space: string,          // Parent space ID
  name: string,           // Group display name
  description: string,    // Optional description
  isPublic: boolean,      // Visibility setting
  moderators: string[]    // Array of user IDs with moderator role
}

​
Creating a Group

1

Navigate to Your Space

Go to the space where you want to create a group. You must be a space owner or moderator to create groups.
2

Access Group Creation

Look for the “Create Group” or “New Group” button, typically found in the groups section of your space.
3

Configure Group Settings

Fill in the group details:Name (required)
  • Clear, descriptive name for the group
  • Example: “Data Structures - Fall 2026” or “Photography Club”
Description (optional)
  • Explain the group’s purpose
  • Set expectations for members
  • Include any relevant rules or guidelines
Visibility
  • Public: Any space member can discover and join
  • Private: Invitation or approval required to join
4

Assign Initial Moderators

The creator is automatically added as a moderator. You can add additional moderators who will help manage the group.
5

Create the Group

Click the create button. The group will be immediately available to space members (if public) or ready for invitations (if private).

​
Managing Group Members

​
Viewing Members

To see all group members: 
// Members are listed with pagination
const members = await getGroupMembers(groupId, {
  page: 1,
  perPage: 50,
  search: '' // Optional search by username or name
});
The member list displays:
  • User profile information
  • Role within the group
  • Join date

​
Member Roles

RolePermissions
ModeratorCan manage members, moderate content, and configure group settings
MemberCan participate in discussions and view group content

​
Adding Members

For public groups, members can join themselves:
  1. Navigate to the group page
  2. Click the “Join Group” button
  3. Membership is granted immediately
Users must be members of the parent space before they can join a group.

​
Removing Members

Moderators can remove members from groups:
1

Access Member List

Navigate to the group’s member management page
2

Find the Member

Use the search function if needed to locate specific members
3

Remove Member

Click the remove or ban option next to the member’s name
4

Confirm Action

Confirm the removal. The member will lose access to group content and discussions.
Removed members can rejoin public groups unless explicitly banned. For permanent removal, consider making the group private or implementing a ban list.
Search for specific members by:
  • Username
  • Display name
// Example search
const results = await getGroupMembers(groupId, {
  search: 'john'
});

​
Group Moderation

​
Assigning Moderators

To promote a member to moderator:
  1. Ensure they are already a group member
  2. Access member management
  3. Select the member
  4. Change their role from “member” to “moderator”
Moderators can:
  • Add and remove members
  • Delete posts and comments
  • Update group settings
  • Assign additional moderators

​
Moderator Best Practices

Create and communicate group rules:
  • Expected behavior
  • Content policies
  • Consequences for violations
Post these in a pinned message or group description.
Avoid single points of failure:
  • Assign multiple moderators
  • Cover different time zones if applicable
  • Define specific responsibilities for each moderator
Stay engaged with your group:
  • Review new posts regularly
  • Respond to member reports
  • Check for inactive members
Keep records of moderation actions:
  • Why members were removed
  • Policy changes
  • Important discussions
This helps maintain consistency and transparency.

​
Managing Group Settings

​
Updating Group Information

Group moderators and space owners can update: 
await updateGroup(groupId, {
  name: 'Updated Group Name',
  description: 'New description',
  isPublic: false // Change visibility
});

​
Deleting a Group

Deleting a group is permanent and cannot be undone. All group-specific content and memberships will be removed.
Before deleting a group:
  1. Export any important content
  2. Notify members in advance
  3. Consider archiving instead of deleting
To delete: 
await deleteGroup(groupId);

​
Checking Membership Status

Users and moderators can check membership programmatically: 
// Check if current user is a member
const isMember = await isGroupMember(groupId);

// Get current user's role
const role = await getGroupMembershipRole(groupId);
// Returns: 'moderator', 'member', or null

​
Common Use Cases

Course Groups

Organize students by course or semester:
  • One group per course
  • Share course materials
  • Post assignments and discussions

Interest Groups

Create communities around shared interests:
  • Hobby or activity-based
  • Open to all space members
  • Member-driven content

Project Teams

Manage collaborative projects:
  • Private groups for team members
  • Share project files and updates
  • Coordinate meetings and tasks

Study Groups

Facilitate peer learning:
  • Self-organized by students
  • Share notes and resources
  • Schedule study sessions

​
Next Steps

Moderate Content

Learn how to use moderation tools to maintain healthy group discussions

Build docs developers (and LLMs) love

Get started for freeTalk to us