← API reference
Query / surfaces

getJourney

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

Arguments

TypeID of the journey to fetch (prefix jny). Returns null when it does not exist or the caller's scope/domain grants do not admit it — a hidden journey is indistinguishable from a missing one.

Returns Journey

Scalar fields at a glance

revisionInt!
handleString!
versionInt!
publishedVersionIdJourneyVersionID
↗ View the complete Journey type

Explore in a view

Journeys and Workspaces
View exact SDL
"""Fetch a single journey by ID, if the caller may see it."""
getJourney(
  """
  TypeID of the journey to fetch (prefix `jny`). Returns null when it does not exist or the caller's scope/domain grants do not admit it — a hidden journey is indistinguishable from a missing one.
  """
  id: JourneyID!
): Journey @topic(names: ["surfaces"])

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