CoCoCoCoCoCo / docs
← API reference
Query / surfaces

getWorkspaceByHandle

Fetch a workspace by its stable handle (deep links / anchored launches), if the caller may see it.

Arguments

handleString!

The workspace's stable handle (its definition's id), unique within the tenant. Returns null when unknown or not visible to the caller.

Returns Workspace

Scalar fields at a glance

idWorkspaceID!
handleString!
statusWorkspaceStatus!
versionInt!
publishedVersionIdWorkspaceVersionID
requiredDomains[String!]!
↗ View the complete Workspace type

Explore in a view

Journeys and Workspaces
View exact SDL
"""
Fetch a workspace by its stable handle (deep links / anchored launches), if the caller may see it.
"""
getWorkspaceByHandle(
  """
  The workspace's stable handle (its definition's `id`), unique within the tenant. Returns null when unknown or not visible to the caller.
  """
  handle: String!
): Workspace @topic(names: ["surfaces"])

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