journey

Get step detail

Get detailed information about a specific journey step. Opening a step for the first time marks it as 'in_progress'.

get/api/journey/steps/{step_code}

Path parameters

step_codestring required

Response

Successful Response

codestring required

Step unique code

titlestring required

Step title

descriptionstring nullable

Step description

iconstring required

Icon name

status'locked' | 'unlocked' | 'in_progress' | 'completed' required

Journey step status constants.

phase_codestring required

Phase code

phase_namestring required

Phase display name

background_color_hexstring required

Background color for the phase

trackstring required

Track/status this step belongs to

completed_atstring nullable

ISO datetime when the step was completed (from progress or milestone)

event_datestring nullable

ISO date when the underlying event occurred

Example response

{
  "background_color_hex": "#F3E8FF",
  "code": "appointment_1",
  "completed_at": "2025-06-15T10:30:00+00:00",
  "contents": [
    {
      "description": "Un messaggio dal team Corabea",
      "id": "appointment_1_video_1",
      "is_completed": true,
      "metadata": {
        "duration_seconds": 180
      },
      "type": "video",
      "url": "https://www.youtube.com/watch?v=example"
    }
  ],
  "description": "Benvenuto nel tuo percorso",
  "event_date": "2025-06-15T10:00:00+00:00",
  "icon": "video",
  "phase_code": "initial",
  "phase_name": "Fase Iniziale",
  "status": "in_progress",
  "title": "Il tuo primo passo",
  "track": "attivo"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.