MyPathways

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

MyPathways

FieldTypeRequiredDescription
itemsarray of PathwayProgressyes

Every unarchived pathway assigned to the caller, with derived progress.

jsonExample
{
  "items": [
    {
      "pathway_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "slug": "string",
      "name": "string",
      "description_markdown": "string",
      "attachments": [
        null
      ],
      "job_aids": [
        {
          "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
          "title": "string",
          "description": "string",
          "audience": "trainees",
          "archived": true
        }
      ],
      "phases": [
        {
          "phase_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"
          ],
          "state": "locked",
          "level_count": 0,
          "complete_level_count": 0
        }
      ],
      "levels": [
        {
          "level_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
          "name": "string",
          "description": "string",
          "description_markdown": "string",
          "attachments": [
            null
          ],
          "job_aids": [
            {
              "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
              "title": "string",
              "description": "string",
              "audience": "trainees",
              "archived": true
            }
          ],
          "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"
          ],
          "state": "locked",
          "assignment": "assigned",
          "applicable_count": 0,
          "awarded_count": 0,
          "has_overdue": true,
          "certifications": [
            {
              "certification_type_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
              "slug": "string",
              "name": "string",
              "applies_to_user": true,
              "awarded": true,
              "overdue": true
            }
          ]
        }
      ],
      "current_level_ids": [
        "1b671a64-40d5-491e-99b0-da01ff1f3341"
      ],
      "complete": true
    }
  ]
}