Skip to content
HeyX API

List Journey Config

Required scope: journey:read

Every workspace has one customer journey made up of tracks, and each track holds an ordered list of statuses. A customer can sit on at most one status per track. Use this endpoint to discover the id values you need before moving a customer with Set Customer Journey Status.

Tracks and statuses are returned in their configured display order (position). Archived tracks and statuses are omitted unless you pass includeArchived: true.

Each status reports a statusChangeMode. When it is an approval mode, setting a customer to that status may open an approval request instead of applying the change immediately — see Set Customer Journey Status for how that outcome is reported.

Generated Reference
POST /public-api/publicapi.v1.Journey/ListJourneyConfig

Lists the workspace journey tracks and their statuses, limited to the tracks the API key's member can read.

Request ListJourneyConfigRequest
Response ListJourneyConfigResponse

ListJourneyConfigRequest

Field Type Description
include_archived bool Include archived tracks and statuses. Defaults to false (active only).

ListJourneyConfigResponse

Field Type Description
tracks repeated JourneyTrack Journey tracks the API key's member can read, in display order.

Related Types

JourneyTrack

Field Type Description
id string Stable track identifier.
name string Human-readable track name.
description string Optional longer description of the track.
color_hex string Presentation color as a hex string, for example "#3366FF".
position int32 Display order among tracks; lower values sort first.
archived bool True when the track is archived. Only returned with include_archived.
statuses repeated JourneyStatus Statuses on this track, in display order.

JourneyStatus

Field Type Description
id string Stable status identifier; pass as status_id to SetCustomerJourneyStatus.
name string Human-readable status name.
description string Optional longer description of the status.
color_hex string Presentation color as a hex string, for example "#3366FF".
position int32 Display order within the track; lower values sort first.
status_change_mode string How the status may be set: "manual" applies immediately, "approval" opens an approval request, and "automation_only" cannot be set through this API.
archived bool True when the status is archived. Only returned with include_archived.

Request

Section titled “Request”
{
  "includeArchived": false
}

Response

Section titled “Response”
{
  "tracks": [
    {
      "id": "4c3c9f2e-6d21-4a0b-9d0f-2b1e7c8a4d10",
      "name": "Onboarding",
      "description": "Progress from signup to first install",
      "colorHex": "#2F6FED",
      "position": 0,
      "archived": false,
      "statuses": [
        {
          "id": "b1f0a7d4-2c88-4e13-9a5e-6d9f0c2b3a41",
          "name": "New",
          "description": "Awaiting first contact",
          "colorHex": "#9AA0A6",
          "position": 0,
          "statusChangeMode": "manual",
          "archived": false
        },
        {
          "id": "d3e2c1b0-5a44-4f22-8c17-1e9b7a6d5c33",
          "name": "Won",
          "description": "Contract signed",
          "colorHex": "#1E8E3E",
          "position": 1,
          "statusChangeMode": "approval",
          "archived": false
        }
      ]
    }
  ]
}
HeyX API