← All resources

Resource

workspace

An instance-served workspace: the container record joined with the relevant version's definition (the published version when published, else the open draft). A workspace is the standing surface a role works in — panels of live data plus one-tap actions that run mutations as the signed-in user. For a technical team's own monitoring board, with no actions, use a Dashboard instead.

GraphQL reference →

Configuration

publishedVersionIdWorkspaceVersionIDOptional

TypeID of the live published version (prefix wsv); null while the workspace only has drafts. The same fact as version when published, as a reference — a version number is server-assigned, so only the id can be pointed at by configuration written before the version exists.

References workspace_version

written by `publishWorkspace`, not by this resource's update

scopeWorkspaceScope!Optional

Distribution scope for the new workspace. Defaults to INSTANCE when omitted. TEAM/INSTANCE require workspace:write; PERSONAL (owned by the caller) is self-service.

Allowed values

PERSONAL — Owned by one user and visible only to them. Self-service: authoring it needs workspace:personal rather than workspace:write, and workspace:write is not a backdoor into someone else's personal workspace.

TEAM — Offered to the members of the teams it is assigned to; at least one team is required. Authoring it needs workspace:write.

INSTANCE — Offered to everyone in the tenant whose permissions cover its requiredDomains. The default scope when none is given; authoring it needs workspace:write.

teamIds[TeamID!]!Optional

TypeIDs (prefix tea) of the teams to assign; ignored unless scope is TEAM, in which case at least one existing team is required.

References team

sourceStringRequired

Workspace source, including its document and server Lua.

/sourceXML: workspace_document fields

Open model reference →

The root element of a Workspace: a screen of panels that read and edit business data. It declares shared state, server Lua handlers, data sources and the layout.

object
childrenOptional
domainsOptional

Space-separated business domains the workspace relates to. They are hints and grant no permissions.

string
idRequired

Unique identifier: lowercase letters, digits and hyphens, starting with a letter.

string
Minimum length
1
roleRequired

The audience the workspace is for, such as Sales or Operations.

string
Minimum length
1
titleRequired

Heading shown to users.

string
Minimum length
1

Only the fields listed here are accepted.

Read-only values

Show values
idWorkspaceID!Read only

TypeID of the workspace container record (prefix wks, e.g. "wks_01K…"). Stable across versions.

computed by the platform

handleString!Read only

Stable, tenant-unique handle, derived from the definition's id — never supplied separately. Used for deep links and anchored launches.

computed by the platform

statusWorkspaceStatus!Read only

Computed lifecycle status: PUBLISHED when a live published version exists, else DRAFT.

Allowed values

DRAFT — An unpublished version; ordinary drafts are editable while IaC source snapshots are fixed. Never served to runners. On the workspace record it means no published version exists yet.

PUBLISHED — An immutable, live version — the only status runners fetch. On the workspace record it means a live published version exists, even when a newer draft is open beside it.

computed by the platform

versionInt!Read only

Version number of the version definition came from: the published version when published, else the open draft. Starts at 1 and increments per authored draft.

computed by the platform

requiredDomains[String!]!Read only

Permission domains the definition declares it needs (mirrored out of the latest version so unauthorised workspaces can be filtered server-side). Empty when the definition declares none.

computed by the platform

ownerUserIdUserIDRead only

Owner of a PERSONAL workspace; null for TEAM / INSTANCE.

References service_account

computed by the platform

definitionString!Read only

Internal compiled rendering contract. Never submit this field as authored source.

computed by the platform

revisionString!Read only

Revision of the complete authoring snapshot. Empty for runtime-only readers; a non-empty observed revision is required for IaC updates.

computed by the platform

hasDraftBoolean!Read only

True when an unpublished draft exists for this workspace.

computed by the platform

createdAtISO8601!Read only

ISO-8601 timestamp when the workspace was first created (its first version authored).

computed by the platform

updatedAtISO8601!Read only

ISO-8601 timestamp of the last change to the workspace container — a new draft, an edit, a scope/team change, or a publish.

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.