PathwayLevel

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

PathwayLevel

FieldTypeRequiredDescription
idstring (uuid)yes—
pathway_idstring (uuid)yes—
namestringyes—
descriptionstring | nullyes—
description_markdownstring | nullyes

Long-form narrative markdown below the summary line; never parsed.

positionintegeryes

Authored order — the stable tie-break parallel branches render in.

phase_idstring (uuid) | nullyes

The phase grouping this level, or null for an ungrouped level.

depends_on_level_idsarray of string (uuid)yes

Levels that must all be complete before this one unlocks; empty for a root level.

depends_on_phase_idsarray of string (uuid)yes

Phases every level of which must be complete before this one unlocks, on top of depends_on_level_ids. Never the level's own phase.

certificationsarray of PathwayLevelCertificationyes

The certification types this level groups, in authored order.

attachmentsarray of PathwayAttachmentyes

Every description attachment of the level, trainee handouts and trainer resources alike, in authored order. The bytes are fetched through GET /learning-pathway-levels/{level_id}/attachments/{attachment_id}/download.

job_aidsarray of JobAidRefyes

The job aids presented on the level, in authored order — reading material only; nothing about progress depends on them. Replaced through PUT /learning-pathway-levels/{level_id}/job-aids.

created_atstring (date-time)yes—
jsonExample
{
  "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"
}