Skip to main content
Manage workspaces within your Well organization. Workspaces are containers that group people, projects, and resources together for collaboration and access control.

​
Getting Started

The Workspaces API allows you to create and manage workspace records that serve as organizational units within your system.

Create your first Workspace

Start by creating a workspace for your team

​
How Workspace Management Works

  1. Create workspaces: Add workspace records with metadata and descriptions
  2. Manage memberships: Link people to workspaces with specific roles
  3. Access control: Control who can access workspace resources
  4. Organization scoped: Workspaces are scoped to your organization
  5. Lifecycle management: Track creation, updates, and deletion events

​
Workspace Features

  • Team Organization: Group people and resources logically
  • Access Control: Manage permissions through memberships
  • Resource Isolation: Keep workspace data separate and secure
  • Collaboration: Enable team collaboration within workspace boundaries

​
Quick Start Examples

  • JavaScript
  • cURL
// Create a workspace
const response = await fetch('https://api.wellapp.ai/v1/workspaces', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      type: 'workspace',
      attributes: {
        name: 'Development Team',
        description: 'Main development workspace for the engineering team'
      }
    }
  })
});

​
Key Features

  • JSON:API Standard: All endpoints follow JSON:API specification for consistency
  • Membership Integration: Seamlessly integrates with the Memberships API
  • Flexible Organization: Create workspaces for teams, projects, or any logical grouping
  • Filtering & Pagination: Efficient data retrieval with query parameters
⌘I