v1

latestOpenAPI 3.1.02026-07-22750642.5 KB
Journeys

Get journey definition

Get a journey's full editable graph (all nodes, their config, and connections) so it can be modified and saved back. Unlike journeys_get, this is the complete authoring shape, not the sanitized public summary.

get/api/v1/journeys/{journeyId}/definition

Path parameters

journeyIdstring required

A draft journey id, or the initiative id (resolves to its current draft).

Response

Success

idstring required

Journey (workflow version) id.

initiativeIdstring required

The initiative this journey belongs to.

status'DRAFT' | 'PUBLISHED' | 'STOPPED' required

DRAFT (editable), PUBLISHED (live, frozen), or STOPPED (retired).

versioninteger required

Version number within the initiative.