โ† API reference
Query / surfaces

getWorkspace

Fetch a single workspace by ID, if the caller may see it.

Arguments

TypeID of the workspace to fetch (prefix wks). Returns null when it does not exist or the caller may not see it.

Returns Workspace

Scalar fields at a glance

handleString!
versionInt!
publishedVersionIdWorkspaceVersionID
requiredDomains[String!]!
โ†— View the complete Workspace type

Explore in a view

Journeys and Workspaces
View exact SDL
"""Fetch a single workspace by ID, if the caller may see it."""
getWorkspace(
  """
  TypeID of the workspace to fetch (prefix `wks`). Returns null when it does not exist or the caller may not see it.
  """
  id: WorkspaceID!
): Workspace @topic(names: ["surfaces"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.