Skip to content

Workspace

The workspace is the top-level tenant. Owners and admins manage settings; everyone else sees a read-only view.

Endpoints

GET    /api/v1/workspaces                      list (auth)
GET    /api/v1/workspace                       current workspace (attachWorkspace)
PATCH  /api/v1/workspace                       update (admin)
GET    /api/v1/workspace/audit-log             audit log (admin, feature-gated)

Workspace fields

typescript
{
  name: string,
  slug: string,                  // unique
  owner_uid: ObjectId,
  plan_code: string,             // default "free"
  subscription_id: ObjectId | null,
  default_currency: "TRY" | "USD",   // default "TRY"
  locale: string,                // default "tr"
  billing_address: {
    name, line1, line2, city, country, postal, tax_id
  },
}

What admins can change

  • Name and slug (slug is unique across the instance).
  • Default currency and locale.
  • Billing address — used on invoices.
  • Plan via Upgrade.

Members

The workspace member list is at GET /workspace/members and the role matrix is in Roles.