Groups API Overview
Groups in Tribe Social allow users to create and join communities around shared interests, content, or purposes. The Groups API provides endpoints for creating, managing, and interacting with groups within the Tribe Social platform.
Key Features
- Create and manage groups
- Control group visibility and access
- Add and remove group members
- Manage group content and collections
- Retrieve group information
Group Types
Groups in Tribe Social can have different visibility settings:
- Public: Visible to all users, anyone can join
- Private: Visible in listings, but requires approval to join
- Hidden: Not visible in listings, users must be invited
Common Use Cases
- Creating community spaces for specific topics or interests
- Organizing content for different audience segments
- Building exclusive spaces for premium content
- Managing team collaboration areas
Available Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/my-groups | GET | Get groups where the user is a member |
/api/group | GET | Get a specific group by its id or slug |
/api/group | POST | Create or update a group |
/api/group/contents | GET | Get contents belonging to a group |
/api/group/collections | GET | Get collections belonging to a group |
/api/group/:id/user/:userId | DELETE | Remove a user from a group |
/api/groups/platform/:platformId | GET | Get groups by platform ID |
Authentication Requirements
Most group endpoints require authentication with a valid token. The required role varies by endpoint:
- Group creation requires creator privileges
- Group management typically requires admin role
- Viewing group information may be available to any authenticated user depending on group visibility
Related Resources
- User API - For managing user relationships with groups
- Authentication API - For authenticating users to access groups
- Push Notifications - For sending notifications to group members