Skip to main content
The Workspace entity represents workspaces in the Well system. It constitutes the main tenant level for organizing people, companies and data within an organization.

Table structure

Table name: workspaces

Main fields

NameTypeRequiredConstraintsAllowed ValuesDescriptionExample
idstring, UUID, πŸ”’ systemβœ… YesUnique identifier (read-only)–Unique identifier of the workspace previously created”workspace-uuid-123”
namestringβœ… Yes1–100 chars–Workspace name”My Marketing Team”
descriptionstringβšͺ Nomax 500 chars–Workspace description”Workspace for marketing and communication team”
avatar_imagestringβšͺ Nonullable URL–Workspace profile image URL”https://example.com/workspace-avatar.jpg”
trustedbooleanβšͺ Nodefault: falsetrue, falseIndicates if the workspace is trustedfalse
avatar_colorstringβšͺ Nohex or color name–Avatar color for customization”#3B82F6”
external_workspace_idstringβšͺ Nounique, nullable–External ID for integrations”external-123”
created_atstring (ISO 8601) πŸ”’ system–auto timestamp–Creation timestamp”2023-01-01T12:00:00Z”
updated_atstring (ISO 8601) πŸ”’ system–auto timestamp–Last updated timestamp”2024-01-01T12:00:00Z”
deleted_atstring | null πŸ”’ systemβšͺ Nonullable ISO 8601–Deletion timestamp (soft delete)β€œ2024-01-01T12:00:00Z”

Relations

The Workspace entity has several important relationships with other entities:

One-to-Many relations

  • Membership: Workspace members (users)
  • CompanyWorkspace: Companies associated with the workspace
  • PersonWorkspaces: People associated with the workspace
  • Webhook: Webhooks configured for the workspace

Relationship schema

Workspace (1) ←→ (N) Membership ←→ (1) People (member users)
Workspace (1) ←→ (N) CompanyWorkspace ←→ (1) Company
Workspace (1) ←→ (N) PersonWorkspaces ←→ (1) People
Workspace (1) ←→ (N) Webhook
⌘I