Journeys

Tags: journeys, members

Endpoints

• GET - List
• POST - Create
• DELETE /{journey_id} - Delete Journey Id
• GET /{journey_id} - Get Journey Id
• PUT /{journey_id} - Update Journey Id
• GET /{journey_id}/health - Health

List

GET /api/v2/w/{workspace_uuid}/journeys

Description:

Member journey tracking and progression

List all journeys, paginated.

Authorization: Requires journeys:read scope

Parameters:

• include_archived (Boolean)
• sortBy (JourneySortField)
• sortOrder (SortOrder)
• page (Integer)
• pageSize (Integer)

Response: See PaginatedResponse[JourneyResponse]

---

Create

POST /api/v2/w/{workspace_uuid}/journeys

Description:

Member journey tracking and progression

Create a new journey.

Authorization: Requires journeys:write scope

Parameters:

• request - See CreateJourneyRequest

Response: See JourneyResponse

---

Delete Journey Id

DELETE /api/v2/w/{workspace_uuid}/journeys/{journey_id}

Description:

Member journey tracking and progression

Archive a journey (soft delete).

Authorization: Requires journeys:admin scope

Parameters:

• journey_id (Integer)

---

Get Journey Id

GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}

Description:

Member journey tracking and progression

Get a journey by ID with steps and goals.

Authorization: Requires journeys:read scope

Parameters:

• journey_id (Integer)
• experimentId (Integer)

Response: See JourneyResponse

---

Update Journey Id

PUT /api/v2/w/{workspace_uuid}/journeys/{journey_id}

Description:

Member journey tracking and progression

Update an existing journey.

Authorization: Requires journeys:write scope

Parameters:

• journey_id (Integer)
• request - See UpdateJourneyRequest

Response: See JourneyResponse

---

Health

GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}/health

Description:

Member journey tracking and progression

Return Journey Health diagnostics — authoring issues + runtime failures.

Authorization: requires Scope.JOURNEYS_WRITE because every primary action exposed by the Health UI mutates the journey (the edge editor for authoring issues; the same editor for runtime failures). Read-only viewers should not see the surface at all.

PHI policy: the response carries only PHI-safe AbilityConfigIssue entries — IDs, operator-set names, counts, error_type strings, and timestamps. No CEL text, no exception messages, no Member data.

Authorization: Requires journeys:write scope

Parameters:

• journey_id (Integer)

Response: See JourneyHealthResponse

---