PathwayDetail

A request or response body; the type column links to the schemas it refers to.

PathwayDetail

Field	Type	Required	Description
journey	Pathway	yes	—
attachments	array of PathwayAttachment	yes	Every description attachment of the pathway, trainee handouts and trainer resources alike, in authored order. The bytes are fetched through GET /learning-pathways/{pathway_id}/attachments/{attachment_id}/download.
job_aids	array of JobAidRef	yes	The job aids presented on the pathway as a whole, in authored order. Replaced through PUT /learning-pathways/{pathway_id}/job-aids.
phases	array of PathwayPhase	yes	Every phase with the phases it comes after and its levels, in dependency order.
levels	array of PathwayLevel	yes	Every level with its prerequisites and contents, in authored order.
assignments	array of PathwayAssignment	yes	Who the pathway is presented to.

jsonExample

{
  "journey": {
    "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "owner_organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "slug": "string",
    "name": "string",
    "description_markdown": "string",
    "archived_at": "2026-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z"
  },
  "attachments": [
    null
  ],
  "job_aids": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "title": "string",
      "description": "string",
      "audience": "trainees",
      "archived": true
    }
  ],
  "phases": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "pathway_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "name": "string",
      "description_markdown": "string",
      "depends_on_phase_ids": [
        "1b671a64-40d5-491e-99b0-da01ff1f3341"
      ],
      "level_ids": [
        "1b671a64-40d5-491e-99b0-da01ff1f3341"
      ],
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "levels": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "pathway_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "name": "string",
      "description": "string",
      "description_markdown": "string",
      "position": 0,
      "phase_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "depends_on_level_ids": [
        "1b671a64-40d5-491e-99b0-da01ff1f3341"
      ],
      "depends_on_phase_ids": [
        "1b671a64-40d5-491e-99b0-da01ff1f3341"
      ],
      "certifications": [
        {
          "certification_type_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
          "slug": "string",
          "name": "string",
          "archived": true
        }
      ],
      "attachments": [
        null
      ],
      "job_aids": [
        {
          "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
          "title": "string",
          "description": "string",
          "audience": "trainees",
          "archived": true
        }
      ],
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "assignments": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "pathway_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "assignee_kind": "role",
      "role_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "role_name": "string",
      "department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "department_name": "string",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}