Platforms Overview

Platforms are the top-level organizational entities in the Tribe API. Each platform represents a distinct community or application instance with its own users, content, collections, groups, and settings.

Platform Concepts

A platform in Tribe Social:

• Serves as a container for all other resources (users, content, collections, groups)
• Has its own unique configuration and settings
• Can be customized with white-labeling and custom domains
• Has platform-specific analytics and metrics
• Can have multiple administrators with different permission levels

Available Endpoints

The Platforms API provides the following endpoints:

Endpoint	Method	Description
/api/platform/:id	GET	Get platform by ID
/api/platform/info	GET	Get platform information for the authenticated user
/api/platform/homepage/:url	GET	Get platform by homepage URL
/api/platform/slug/:slug	GET	Get platform by slug
/api/platform	POST	Create or update a platform
/api/platform/:id	DELETE	Delete a platform
/api/platforms/dashboard	GET	Get all platforms for dashboard (admin only)
/api/platform/analytics	GET	Get platform analytics

Platform Object Structure

A typical platform object includes the following properties:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Example Community",
  "slug": "example-community",
  "description": "A community for example purposes",
  "homepageURL": "https://example.tribesocial.io",
  "customDomain": "community.example.com",
  "logoURL": "https://example.com/logo.png",
  "faviconURL": "https://example.com/favicon.ico",
  "primaryColor": "#4A90E2",
  "secondaryColor": "#50E3C2",
  "tertiaryColor": "#F5A623",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-15T00:00:00.000Z",
  "settings": {
    "allowPublicRegistration": true,
    "requireEmailVerification": true,
    "defaultUserRole": "member"
  }
}

Authentication Requirements

Most platform endpoints require authentication. Platform management operations (create, update, delete) typically require admin privileges. Some read-only endpoints may be accessible to authenticated users with various roles depending on the platform's configuration.

Common Use Cases

• Platform Creation: Setting up a new community or application instance
• Platform Configuration: Customizing appearance, settings, and behavior
• White Labeling: Applying custom branding and domain settings
• Platform Analytics: Monitoring usage, engagement, and performance metrics
• Platform Management: Administrative operations for platform maintenance