Skip to main content
GET
Get Journey
Returns the journey definition for an ID in your account. A missing journey, an ID belonging to another account, or a malformed ID returns 404. A malformed ID returns error: "Journey not found" with code: "not_found". Declares the journeys.read scope. Authenticate with X-Api-Key; see Authentication.

Path Parameters

string
required
Journey ID returned by create or list. A malformed ID returns 404 rather than the journey.

Response

The journey object uses camelCase: id, integer accountId, name, trigger, priority, steps, startStepId, status, pauseReason, createdAt, and updatedAt. The trigger can be null. Each step contains stepId, name, stepType, config, and nullable nextStepId. Pause reasons and absent timestamps can be null.