Workspaces API

Organization API

The Workspaces API provides workspace management, settings, and provisioning.

Quick Navigation

• Overview
• Base Path
• Authentication
• Workspaces Flow
  • Workspaces Flow Diagram
• Endpoints
• Internal Notes
• Swagger Documentation

Overview

This module provides:

• Workspace creation and management
• Workspace settings
• Workspace cloning
• Automated workspace provisioning

Base Path

All workspace endpoints are prefixed with /api/v1/workspaces

Authentication

All endpoints require authentication:

Authorization: Bearer <access_token>

Workspaces Flow

The Workspaces API enables comprehensive workspace management. Users can create workspaces, manage settings, clone existing workspaces, and use automated provisioning for efficient workspace setup and configuration.

Workspaces Flow Diagram

View Flow Diagram

Workspaces Flow Overview:

This flow diagram illustrates the workspace management workflow. It shows how workspaces are created, managed, cloned, and provisioned within organizations, and how workspace settings are configured.

Key Flow Components:

1. Workspace Creation: Users create workspaces within organizations with initial configuration and settings
2. Workspace Management: View, update, and manage workspace details, including workspace information and metadata
3. Workspace Cloning: Clone existing workspaces with all configurations and settings replicated to new workspaces
4. Settings Management: Configure workspace-specific settings including permissions, features, and integrations
5. Bulk Provisioning: Automated provisioning of multiple workspaces for efficient setup and configuration
6. Organization Relationship: Workspaces are scoped to organizations and inherit organization-level settings
7. Permission Model: Access control based on organization membership and admin roles for workspace operations

Internal Developer Notes:

• Workspaces are automatically created with organizations on user signup
• Workspace settings can be customized per workspace
• Cloning preserves workspace configuration and settings
• Bulk provisioning enables efficient multi-workspace setup
• Workspace operations are scoped to organization membership

Endpoints

Method	Endpoint	Description
POST	/	Create workspace
GET	/	List workspaces
GET	/{workspace_id}	Get workspace details
PUT	/{workspace_id}	Update workspace
DELETE	/{workspace_id}	Delete workspace
POST	/{workspace_id}/clone	Clone workspace
GET	/{workspace_id}/settings	Get workspace settings
PUT	/{workspace_id}/settings	Update workspace settings
POST	/provision	Provision workspaces

Internal Notes

• [WARNING] Not implemented - All endpoints have TODO comments
• Endpoint stubs exist with proper schemas
• Basic workspace operations exist under /api/v1/organizations/{org_id}/workspaces

Swagger Documentation

Interactive API documentation available at: /docs#/workspaces