fa74265a328d
Get entity from Journey by key
Path parameters
Id of the Journey
Query parameters
Select properties to be returned
Expand related entities
Response
Retrieved entity
Internal identifier for ChurnZero.
The description for the Journey.
The number of days an Account is expected to be in the Journey.
True if the Journey is currently running and being evaluated. Kept in sync with Status: activating a Draft or Paused Journey sets Status to Running, and deactivating a Running Journey sets Status to Paused.
True if this Journey is configured for external sharing, which lets designated customer contacts view the Journey's progress and externally visible steps outside of ChurnZero.
The name of the Journey.
The date/time the Journey record was created. ISO 8601 formatted string.
The date/time the Journey record was last modified. ISO 8601 formatted string.
Progress Scale threshold, in days from the Account's Journey start (Days In). An Account at or below this many days is 'On Track'; beyond it is 'Behind'. (Set per Journey in the Progress Scale; need not be a fixed fraction of ExpectedDuration.)
Progress Scale threshold, in days from the Account's Journey start (Days In). Beyond this the Account is 'Stuck'; between ProgressBottom and ProgressTop it is 'Behind'. Note an Account's overall Journey Status (JourneyProgress.Status) is also raised to the worst of its in-progress Milestones, so it can read 'Stuck' before Days In reaches ProgressTop.
The Journey's configuration lifecycle state: Draft, Paused, Running (shown as 'Active' in the ChurnZero UI), or MarkedForDeletion. This describes the Journey definition itself, NOT an Account's progress — an Account's On Track/Behind/Stuck progress status lives on the JourneyProgress entity's Status.