Organizations API

Organization API

The Organizations API manages organizations, workspaces, roles, and member invitations.

Quick Navigation

• Overview
• Base Path
• Authentication
• Organizations Flow
• Endpoints
• Internal Notes
• Swagger Documentation

Overview

This module provides:

• Organization creation and management
• Workspace management within organizations
• Role management
• Member invitations

Base Path

All organization endpoints are prefixed with /api/v1/organizations

Authentication

All endpoints require authentication:

Authorization: Bearer <access_token>

Organizations Flow

The Organizations API provides comprehensive organization and workspace management. Administrators can create organizations, manage workspaces, assign roles, and invite members to collaborate.

Organizations Flow Diagram

View Flow Diagram

Organizations Flow Overview:

This flow diagram illustrates the organization and workspace management workflow. It shows how organizations are created, how workspaces are managed within organizations, and how roles and memberships are handled.

Key Flow Components:

1. Organization Creation: Users can create organizations with automatic workspace and default role setup
2. Workspace Management: Organizations can contain multiple workspaces for different projects or teams
3. Role Management: Default roles (Admin, Developer, Viewer) are created with organizations
4. Member Invitations: Administrators can invite members to join organizations
5. Multi-tenancy: Each user can belong to multiple organizations with different roles

Internal Developer Notes:

• Personal organization and workspace are automatically created on user signup
• Default roles are provisioned with each organization
• Workspaces are scoped to organizations
• Organization membership determines access to resources

Endpoints

Method	Endpoint	Description
POST	/	Create organization
PATCH	/{org_id}	Update organization
GET	/	List organizations
GET	/{org_id}	Get organization by ID
POST	/{org_id}/members/invite	Invite member
POST	/{org_id}/workspaces	Create workspace
GET	/{org_id}/workspaces	List workspaces
GET	/{org_id}/workspaces/{workspace_id}	Get workspace
GET	/{org_id}/roles	List organization roles

Internal Notes

• All endpoints are fully implemented
• Automatic personal organization and workspace creation on signup
• Default roles (Admin, Developer, Viewer) created with organization
• Organization creation includes user account creation if needed

Swagger Documentation

Interactive API documentation available at: /docs#/organizations