SDK API Reference / Journey

Interface: Journey

Journey response - JSON:API format

Properties

attributes

attributes: object

allowReentry

allowReentry: boolean

Whether profiles can re-enter the journey

audienceId

audienceId: string

Parent segment ID this journey belongs to

createdAt

createdAt: string

Created timestamp

description?

optional description?: string | null

Journey description

goal?

optional goal?: JourneyCriteria | null

Goal segment criteria

journeyBundleId?

optional journeyBundleId?: string | null

Journey bundle ID (for versioning)

journeyBundleName?

optional journeyBundleName?: string | null

Journey bundle name

journeyStages

journeyStages: JourneyStage[]

Journey stages (1-8 stages)

latestExecution?

optional latestExecution?: JourneyExecution | null

Most recent execution

launchedAt?

optional launchedAt?: string | null

Launched timestamp

name

name: string

Journey name

paused

paused: boolean

Whether journey is paused

pausedAt?

optional pausedAt?: string | null

Timestamp when journey was paused

reentryMode?

optional reentryMode?: JourneyReentryMode

Reentry behavior mode

state

state: JourneyState

Journey state

updatedAt

updatedAt: string

Updated timestamp

versionNumber?

optional versionNumber?: number

Version number within bundle

---

id

id: string

---

relationships?

optional relationships?: object

createdBy?

optional createdBy?: object

createdBy.data

data: object

createdBy.data.id

id: string

createdBy.data.type

type: string

parentFolder?

optional parentFolder?: object

parentFolder.data

data: { id: string; type: string; } | null

updatedBy?

optional updatedBy?: object

updatedBy.data

data: object

updatedBy.data.id

id: string

updatedBy.data.type

type: string

---

type

type: "journey"