Workspaces
A workspace is the top-level organisational unit in Lavanda. It serves as the central hub where users manage buildings, configure integrations, and carry out day-to-day operational tasks.
Most data in the Lavanda API is scoped to a workspace. When you authenticate with your API credentials, the token grants access to one or more workspaces depending on how your permissions are configured. See Auth for details.
Key Concepts
Section titled “Key Concepts”Multi-workspace setups
Section titled “Multi-workspace setups”Many customers manage multiple workspaces. A common pattern is to dedicate one workspace per building, though the structure is flexible and depends on how the customer organises their portfolio.
Status
Section titled “Status”A workspace has a status that indicates whether it is currently in use:
| Status | Description |
|---|---|
ACTIVE |
The workspace is live and operational |
CHURNED |
The workspace is no longer active |
Demo workspaces
Section titled “Demo workspaces”Workspaces can be flagged as demo workspaces. Demo workspaces are useful for testing and evaluation purposes without affecting production data.
GraphQL API
Section titled “GraphQL API”Workspace
Section titled “Workspace”| Field | Type | Description |
|---|---|---|
id |
String! |
Unique identifier |
name |
String! |
The name of the workspace |
slug |
String! |
A URL-friendly identifier for the workspace |
status |
Status! |
Whether the workspace is ACTIVE or CHURNED |
demo |
Boolean! |
Whether this is a demo workspace |
logoUrl |
String |
URL of the workspace logo |
externalBrandUuid |
String |
External brand identifier for the workspace |
crmNamespace |
CrmNamespace |
The CRM namespace associated with the workspace |
createdAt |
ISO8601DateTime |
When the workspace was created |
updatedAt |
ISO8601DateTime! |
When the workspace was last updated |
Status - The status of a workspace:
| Value | Description |
|---|---|
ACTIVE |
The workspace is live and operational |
CHURNED |
The workspace is no longer active |
Querying Workspaces
Section titled “Querying Workspaces”Get a single workspace
Section titled “Get a single workspace”query Workspace($id: ID!) { awc { workspace(id: $id) { id name slug status demo logoUrl createdAt updatedAt } }}{ "id": "workspace-id"}List workspaces
Section titled “List workspaces”The workspaces query returns a paginated connection. You can filter by name, slug, or status.
query Workspaces($filters: WorkspacesFiltersInput, $first: Int, $after: String) { awc { workspaces(filters: $filters, first: $first, after: $after) { nodes { id name slug status } totalCount pageInfo { hasNextPage endCursor } } }}{ "filters": { "status": { "eq": "ACTIVE" } }, "first": 10}Available filters
Section titled “Available filters”| Filter | Type | Description |
|---|---|---|
name |
WorkspacesNameInput |
Filter by workspace name. Supports search for partial matching |
slug |
WorkspacesSlugInput |
Filter by exact slug match using eq |
status |
WorkspacesStatusInput |
Filter by status using eq (e.g. ACTIVE or CHURNED) |
MCP Tools
Section titled “MCP Tools”If you are using the Lavanda MCP integration, the following tools are available for working with workspaces:
- search_workspaces - Search and filter workspaces with pagination
See the MCP Tools overview for setup instructions and the full list of available tools.
Relationships
Section titled “Relationships”Workspaces sit at the top of the data hierarchy. Most entities in the API are scoped to a workspace:
- A workspace contains one or more buildings (see Buildings)
- Each building contains unit types and units (see Structure & Terms)
- Bookings, leads, contacts, tickets, invoices, and other domain entities are all associated with a workspace
- Users can belong to multiple workspaces, with roles and permissions configured per workspace
See Structure & Terms for more information on how the inventory hierarchy works within a workspace.