Journeys

Tags: journeys, members

Member journey tracking and progression

In the product: Journeys

Endpoints

• GET /api/v2/w/{workspace_uuid}/journeys - List
• POST /api/v2/w/{workspace_uuid}/journeys - Create
• DELETE /api/v2/w/{workspace_uuid}/journeys/{journey_id} - Delete Journey Id
• GET /api/v2/w/{workspace_uuid}/journeys/{journey_id} - Get Journey Id
• PUT /api/v2/w/{workspace_uuid}/journeys/{journey_id} - Update Journey Id
• GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}/health - Health

List

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

Description:

List all journeys, paginated.

Authorization: Requires journeys:read scope

Parameters:

• include_archived (Boolean)
• sortBy (JourneySortField)
• sortOrder (SortOrder)
• page (Integer) — default: 1, min: 1
• pageSize (Integer) — default: 25, min: 1, max: 500

Response: See PaginatedResponse[JourneyResponse]

---

Create

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

Description:

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:

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:

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:

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:

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

---