Workspaces

A Workspace is the root-level organisational unit in Essal. Every resource in the platform — documents, contacts, users, projects, policies — belongs to a workspace. Your workspace settings, billing plan, and app configuration are all managed at this level.

Workspace Structure

When you sign up for Essal, you create a workspace with a unique slug (e.g. acme-corp). This slug appears in all API requests and forms the namespace for your data:

https://api.essal.cloud/v1/
  └── workspaces/
        └── acme-corp/
              ├── office/
              ├── access/
              ├── sales/
              ├── careers/
              ├── project/
              └── guard/

Each of the six apps operates within the workspace but maintains its own data namespace and permission scope.

Workspace Settings

Workspace-level settings control cross-app behaviour:

Setting	Description
Slug	Unique identifier used in API paths and admin URLs
Display Name	Human-readable name shown in the dashboard
Default Locale	Language and date format applied across all apps
Allowed Domains	Email domains permitted to join the workspace
Billing Plan	Determines feature limits and API quotas
Audit Retention	How long Guard stores audit log entries

Members and Invitations

Workspace members are users who have been granted access to at least one app. Membership is managed via the Essal Access app or the API:

POST /v1/access/users
{
  "email": "jane.doe@example.com",
  "display_name": "Jane Doe",
  "roles": ["office:editor", "project:viewer"]
}

A user can belong to multiple workspaces. Their identity is shared but their roles and permissions are workspace-scoped.

Multi-Workspace Organisations

Enterprise accounts can create multiple workspaces (e.g. one per business unit or region) and link them under a parent Organisation. Linked workspaces share a billing account and can optionally share an identity provider configured in Access.

Workspace API Object

{
  "id": "ws_01HXYZABC",
  "slug": "acme-corp",
  "display_name": "Acme Corp",
  "plan": "enterprise",
  "created_at": "2025-01-15T08:00:00Z",
  "member_count": 142,
  "apps_enabled": ["office", "access", "sales", "careers", "project", "guard"]
}

Getting Started

Platform Concepts

App Guides — Office

App Guides — Access

App Guides — Sales

App Guides — Careers

App Guides — Project

App Guides — Guard

Integrations

Security & Compliance

Workspace Structure

Workspace Settings

Members and Invitations

Multi-Workspace Organisations

Workspace API Object

​Workspace Structure

​Workspace Settings

​Members and Invitations

​Multi-Workspace Organisations

​Workspace API Object

Workspace Structure

Workspace Settings

Members and Invitations

Multi-Workspace Organisations

Workspace API Object