Skip to main content
GET
Get journey

Authorizations

Authorization
string
header
required

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

Path Parameters

journeyId
string
required

Journey id.

Minimum string length: 1

Response

Success

id
string
required

Journey id.

initiativeId
string
required

The initiative this journey belongs to.

name
string
required

Journey name (from its initiative).

status
enum<string>
required

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

Available options:
DRAFT,
ACTIVE,
ARCHIVED
version
integer
required

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

Required range: -9007199254740991 <= x <= 9007199254740991
createdAt
string
required

ISO 8601 timestamp.

updatedAt
string
required

ISO 8601 timestamp.

trigger
object
required
steps
object[]
required

The steps that make up the journey, in the order a person moves through them.