Community

Pathways

Get draft version

get
Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200

OK

get
/v2/pathways/{id}/versions/draft
GET /v2/pathways/{id}/versions/draft HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "draftStructureVersion": 1,
  "lastPublishedAt": "2025-12-05T20:46:44.345Z",
  "draftLastUpdatedAt": "2025-12-05T20:46:44.345Z",
  "creationDate": "2025-12-05T20:46:44.345Z",
  "hasThirdPartyBadges": true,
  "hasDraftChanges": true,
  "preferences": {
    "includeOnPublicPages": true
  },
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0,
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}

Update pathway draft

put
Authorizations
HTTPRequired
Path parameters
idstringRequired
Body
issuerIdstringRequired
Responses
200

OK

put
/v2/pathways/{id}/versions/draft
PUT /v2/pathways/{id}/versions/draft HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1216

{
  "issuerId": "text",
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}
{
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "draftStructureVersion": 1,
  "lastPublishedAt": "2025-12-05T20:46:44.345Z",
  "draftLastUpdatedAt": "2025-12-05T20:46:44.345Z",
  "creationDate": "2025-12-05T20:46:44.345Z",
  "hasThirdPartyBadges": true,
  "hasDraftChanges": true,
  "preferences": {
    "includeOnPublicPages": true
  },
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0,
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}

Create pathway in draft state

post
Authorizations
HTTPRequired
Body
issuerIdstringRequired

ID of the issuer where the pathway will be created

Example: 62aa04adf5afe00d0a6dac72
Responses
200

OK

post
/v2/pathways
POST /v2/pathways HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1285

{
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "preferences": {
    "includeOnPublicPages": true
  },
  "draftRoot": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}
{
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "draftStructureVersion": 1,
  "lastPublishedAt": "2025-12-05T20:46:44.345Z",
  "draftLastUpdatedAt": "2025-12-05T20:46:44.345Z",
  "creationDate": "2025-12-05T20:46:44.345Z",
  "hasThirdPartyBadges": true,
  "hasDraftChanges": true,
  "preferences": {
    "includeOnPublicPages": true
  },
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0,
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}

Evaluate experience on the pathway for a user

post
Authorizations
HTTPRequired
Path parameters
pathwayIdstringRequired
experienceIdstring · uuidRequired
Body
recipientone ofRequired
all ofOptional
or
all ofOptional
or
all ofOptional
passedbooleanRequired
Responses
post
/v2/pathways/{pathwayId}/experience/{experienceId}/submit
POST /v2/pathways/{pathwayId}/experience/{experienceId}/submit HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "recipient": {
    "email": "[email protected]",
    "@type": "email"
  },
  "passed": true
}
No content

Evaluate experience on the pathway for multiple users

post

CSV file should contain recipientId,passed header row. Each row should contain a single entry of recipientId (email:[email protected]) and a passed value (true/false) separated by a comma.

Authorizations
HTTPRequired
Path parameters
pathwayIdstringRequired
experienceIdstring · uuidRequired
Body
stringOptionalExample: recipientId,passed email:[email protected],true
Responses
200

OK

post
/v2/pathways/{pathwayId}/experience/{experienceId}/submit-csv
POST /v2/pathways/{pathwayId}/experience/{experienceId}/submit-csv HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: text/csv
Accept: */*
Content-Length: 51

"recipientId,passed\nemail:[email protected],true\n"
{
  "errors": [
    {
      "recipientId": {
        "email": "[email protected]",
        "@type": "email"
      },
      "error": "NOT_SUBSCRIBED"
    }
  ],
  "successes": [
    {
      "email": "[email protected]",
      "@type": "email"
    }
  ]
}

Get published version

get
Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200

OK

get
/v2/pathways/{id}/versions/published
GET /v2/pathways/{id}/versions/published HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "draftStructureVersion": 1,
  "lastPublishedAt": "2025-12-05T20:46:44.345Z",
  "draftLastUpdatedAt": "2025-12-05T20:46:44.345Z",
  "creationDate": "2025-12-05T20:46:44.345Z",
  "hasThirdPartyBadges": true,
  "hasDraftChanges": true,
  "preferences": {
    "includeOnPublicPages": true
  },
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0,
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}

Promote current draft version to published

post
Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200

OK

post
/v2/pathways/{id}/versions/published
POST /v2/pathways/{id}/versions/published HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "draftStructureVersion": 1,
  "lastPublishedAt": "2025-12-05T20:46:44.345Z",
  "draftLastUpdatedAt": "2025-12-05T20:46:44.345Z",
  "creationDate": "2025-12-05T20:46:44.345Z",
  "hasThirdPartyBadges": true,
  "hasDraftChanges": true,
  "preferences": {
    "includeOnPublicPages": true
  },
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0,
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}

Reverts pathway draft to the current published version

post
Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200

OK

post
/v2/pathways/{id}/versions/draft/revert
POST /v2/pathways/{id}/versions/draft/revert HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "draftStructureVersion": 1,
  "lastPublishedAt": "2025-12-05T20:46:44.345Z",
  "draftLastUpdatedAt": "2025-12-05T20:46:44.345Z",
  "creationDate": "2025-12-05T20:46:44.345Z",
  "hasThirdPartyBadges": true,
  "hasDraftChanges": true,
  "preferences": {
    "includeOnPublicPages": true
  },
  "root": {
    "elementId": "65aa04adf5afe00d0a6dac72",
    "name": "Math 101",
    "shortCode": "M101",
    "description": "Complete Math 101 course",
    "alignmentUrl": "www.example.com/skills/E1",
    "frameworkName": "OSMT",
    "targetCode": "E1",
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "requirements": {
      "childElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        }
      },
      "nonChildElementRequirements": {
        "countRule": {
          "notRequiredCount": 1,
          "@type": "allButN"
        },
        "elementIds": [
          "text"
        ]
      },
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
            "displayOrder": 0
          }
        ]
      },
      "requiredCriteriaCount": 1,
      "courseRequirements": {
        "requiredCourses": [
          {
            "lms": "CANVAS",
            "domain": "canvas.instructure.com",
            "courseId": "123678",
            "name": "Math 101",
            "completionRequirement": {
              "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
              "@type": "completed"
            },
            "displayOrder": 0,
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Conference",
            "description": "Attend Instructure Conference 2025",
            "displayOrder": 0
          }
        ]
      },
      "shortcutBadges": [
        "text"
      ],
      "allowCompletionBadgeShortcut": true
    },
    "requiredForParentCompletion": true,
    "children": []
  }
}

Update pathway group subscriptions

post
Authorizations
HTTPRequired
Path parameters
idstringRequired
Body
groupIdsToAddstring[]RequiredExample: 61aa04adf5afe00d0a6dac72
groupIdsToRemovestring[]RequiredExample: 67aa04adf5afe00d0a6dac72
Responses
200

OK

No content
post
/v2/pathways/{id}/subscriptions
POST /v2/pathways/{id}/subscriptions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "groupIdsToAdd": [
    "61aa04adf5afe00d0a6dac72"
  ],
  "groupIdsToRemove": [
    "67aa04adf5afe00d0a6dac72"
  ]
}
No content

Get progress status for the recipient

get
Authorizations
HTTPRequired
Path parameters
idstringRequired
Query parameters
recipientIdentifierstringRequired

Identifier of the recipient, format: recipientType:recipientId

Example: email:[email protected]
Responses
200

OK

get
/v2/pathways/{id}/recipient-progress
GET /v2/pathways/{id}/recipient-progress?recipientIdentifier=text HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "61aa04adf5afe00d0a6dac72",
  "scope": {
    "identifier": {
      "email": "[email protected]",
      "@type": "email"
    },
    "@type": "recipient"
  },
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "calculationInfo": {
    "staleBeforeVersion": 1,
    "stale": true,
    "computedVersion": 1,
    "computedDate": "2025-12-05T20:46:44.345Z",
    "computedPublishedStructureVersion": 1
  },
  "progress": {
    "endProgress": {
      "status": "COMPLETED",
      "required": 10,
      "completed": 4,
      "failed": 1,
      "inProgress": 3,
      "notStarted": 2
    },
    "elementProgress": {
      "ANY_ADDITIONAL_PROPERTY": {
        "status": "COMPLETED",
        "cappedProgress": {
          "required": 5,
          "completed": 1,
          "inProgress": 1,
          "failed": 2,
          "preRequisiteStepFailed": 1,
          "directRequirementFailed": 1,
          "notStarted": 1
        },
        "completionBadgeNewlyAwarded": true,
        "completedByShortcut": true,
        "badgeProgress": {
          "earnedBadges": [
            "https://api.staging.badgr.dev/public/badges/2Lkni4uvRjGqlz8zCg_5uA"
          ],
          "maxBadgeCount": 1
        },
        "courseProgress": {
          "earnedCriteria": [
            {
              "lms": "CANVAS",
              "domain": "text",
              "courseId": "text",
              "completionRequirement": {
                "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
                "@type": "completed"
              },
              "evaluatedAt": "2025-12-05T20:46:44.345Z"
            }
          ]
        },
        "experienceProgress": {
          "evaluations": [
            {
              "experienceId": "123e4567-e89b-12d3-a456-426614174000",
              "passed": true,
              "lastEvaluatedAt": "2025-12-05T20:46:44.345Z"
            }
          ]
        }
      }
    }
  }
}

Get progress status for the recipient group

get
Authorizations
HTTPRequired
Path parameters
idstringRequired
recipientGroupIdstringRequired
Responses
200

OK

get
/v2/pathways/{id}/recipient-groups/{recipientGroupId}/progress
GET /v2/pathways/{id}/recipient-groups/{recipientGroupId}/progress HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "61aa04adf5afe00d0a6dac72",
  "scope": {
    "recipientGroupId": "text",
    "@type": "groupAggregate"
  },
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "calculationInfo": {
    "staleBeforeVersion": 1,
    "stale": true,
    "computedVersion": 1,
    "computedDate": "2025-12-05T20:46:44.345Z",
    "computedPublishedStructureVersion": 1
  },
  "progressAggregate": {
    "elementProgress": {
      "ANY_ADDITIONAL_PROPERTY": {
        "overallProgress": {
          "progress": {
            "completedValue": 1,
            "requiredValue": 2,
            "failedValue": 1,
            "maxValue": 1
          },
          "notStartedCount": 1,
          "inProgressCount": 1,
          "failedCount": 1,
          "completedCount": 1
        },
        "experienceProgress": {
          "experienceIdsWithFailedRecipients": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "experienceIdsWithNotEvaluatedRecipients": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "courseProgress": {
          "byRequirements": [
            {
              "requirementId": {
                "lms": "CANVAS",
                "domain": "text",
                "courseId": "text",
                "completionRequirement": {
                  "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
                  "@type": "completed"
                }
              },
              "completed": 5
            }
          ]
        }
      }
    }
  }
}

Get aggregate progress status for the entire pathway

get
Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200

OK

get
/v2/pathways/{id}/aggregate-progress
GET /v2/pathways/{id}/aggregate-progress HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "61aa04adf5afe00d0a6dac72",
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "calculationInfo": {
    "staleBeforeVersion": 1,
    "stale": true,
    "computedVersion": 1,
    "computedDate": "2025-12-05T20:46:44.345Z",
    "computedPublishedStructureVersion": 1
  },
  "progressAggregate": {
    "elementProgress": {
      "ANY_ADDITIONAL_PROPERTY": {
        "overallProgress": {
          "progress": {
            "completedValue": 1,
            "requiredValue": 2,
            "failedValue": 1,
            "maxValue": 1
          },
          "notStartedCount": 1,
          "inProgressCount": 1,
          "failedCount": 1,
          "completedCount": 1
        },
        "experienceProgress": {
          "experienceIdsWithFailedRecipients": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "experienceIdsWithNotEvaluatedRecipients": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "courseProgress": {
          "byRequirements": [
            {
              "requirementId": {
                "lms": "CANVAS",
                "domain": "text",
                "courseId": "text",
                "completionRequirement": {
                  "doNotAwardBefore": "2025-12-05T20:46:44.345Z",
                  "@type": "completed"
                }
              },
              "completed": 5
            }
          ]
        }
      }
    }
  }
}

Delete pathway

delete
Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
delete
/v2/pathways/{id}
DELETE /v2/pathways/{id} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousOrganizationsNextUsers

Last updated

Was this helpful?