Appearance
Workspace
Type: Object
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.
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| createdAt | ISO8601! | ISO-8601 timestamp when the workspace was first created (its first version authored). | ||
| definition | String! | The workspace definition as a verbatim JSON document (spec workspace-v1). | ||
| handle | String! | Stable, tenant-unique handle, derived from the definition's id — never supplied separately. Used for deep links and anchored launches. | ||
| hasDraft | Boolean! | True when an unpublished draft exists for this workspace. | ||
| id | WorkspaceID! | TypeID of the workspace container record (prefix wks, e.g. "wks_01K…"). Stable across versions. | ||
| ownerUserId | UserID | Owner of a PERSONAL workspace; null for TEAM / INSTANCE. | ||
| publishedVersionId | WorkspaceVersionID | 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. | ||
| requiredDomains | [String!]! | 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. | ||
| scope | WorkspaceScope! | Distribution scope, which drives authorization: PERSONAL (owner-only, self-service via workspace:personal), TEAM / INSTANCE (require workspace:write to author). | ||
| status | WorkspaceStatus! | Computed lifecycle status: PUBLISHED when a live published version exists, else DRAFT. | ||
| teamIds | [TeamID!]! | Teams a TEAM-scoped workspace is assigned to. | ||
| updatedAt | ISO8601! | ISO-8601 timestamp of the last change to the workspace container — a new draft, an edit, a scope/team change, or a publish. | ||
| version | Int! | 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. |