Skip to main content
GET
Get journey definition

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

journeyId
string
required

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

Minimum string length: 1

Response

Success

id
string
required

Journey (workflow version) id.

initiativeId
string
required

The initiative this journey belongs to.

status
enum<string>
required

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

Available options:
DRAFT,
PUBLISHED,
STOPPED
version
integer
required

Version number within the initiative.

Required range: -9007199254740991 <= x <= 9007199254740991
definition
object
required

The full journey graph.