Skip to main content
GET
Get a lead's journey through the campaign

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required
lead_id
string<uuid>
required

Response

Journey retrieved successfully

Read-only journey of one lead through a campaign's step graph.

Powers the Lead Journey canvas: steps draw/light the path, enrollments mark branch jumps, replies attribute a "Replied" marker, and current / next_scheduled name the lead's present position.

lead_id
string<uuid>
required

Lead ID

status
string
required

Lead status

steps
LeadJourneyStep · object[]

Touchpoints in send order

enrollments
LeadJourneyEnrollment · object[]

Subsequence branch enrollments

replies
LeadJourneyReply · object[]

Replies from the lead

current
string | null

node_key of the last sent touchpoint

next_scheduled
string | null

node_key of the earliest future, unsent, non-invalidated follow-up