v1

latestOpenAPI 3.1.02026-07-22750642.5 KB

Journeys

Get journey

Get one journey by id — its trigger and the ordered steps people move through. Read-only, for inspecting setup.

get/api/v1/journeys/{journeyId}

journeyIdstring required

Journey id.

Success

idstring required

Journey id.

initiativeIdstring required

The initiative this journey belongs to.

namestring required

Journey name (from its initiative).

status'DRAFT' | 'ACTIVE' | 'ARCHIVED' required

DRAFT (still being configured), ACTIVE (live — people can move through it), or ARCHIVED (no longer running).

versioninteger required

Version number of the journey's current setup. Each time the steps are edited and re-activated, the version increases.

createdAtstring required

ISO 8601 timestamp.

updatedAtstring required

ISO 8601 timestamp.