Pathways

Get draft version

get

Authorizations

accessToken

HTTPRequired

Path parameters

idstringRequired

Responses

200

OK

application/jsonapplication/ld+json

pathwayIdstringOptionalExample: 66aa04adf5afe00d0a6dac72

issuerIdstringRequired

ID of the issuer where the pathway was created

Example: 62aa04adf5afe00d0a6dac72

draftStructureVersioninteger · int32Required

lastPublishedAtstring · date-timeOptional

draftLastUpdatedAtstring · date-timeRequired

creationDatestring · date-timeRequired

hasThirdPartyBadgesbooleanRequired

hasDraftChangesbooleanRequired

400

Bad Request

*/*

get

/v2/pathways/{id}/versions/draft

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
  "draftLastUpdatedAt": "2026-03-06T20:00:54.088Z",
  "creationDate": "2026-03-06T20:00:54.088Z",
  "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": "2026-03-06T20:00:54.088Z",
              "@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

accessToken

HTTPRequired

Path parameters

idstringRequired

Body

application/json

issuerIdstringRequired

Responses

200

OK

application/jsonapplication/ld+json

pathwayIdstringOptionalExample: 66aa04adf5afe00d0a6dac72

issuerIdstringRequired

ID of the issuer where the pathway was created

Example: 62aa04adf5afe00d0a6dac72

draftStructureVersioninteger · int32Required

lastPublishedAtstring · date-timeOptional

draftLastUpdatedAtstring · date-timeRequired

creationDatestring · date-timeRequired

hasThirdPartyBadgesbooleanRequired

hasDraftChangesbooleanRequired

400

Bad Request

*/*

put

/v2/pathways/{id}/versions/draft

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
              "@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": "2026-03-06T20:00:54.088Z",
  "draftLastUpdatedAt": "2026-03-06T20:00:54.088Z",
  "creationDate": "2026-03-06T20:00:54.088Z",
  "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": "2026-03-06T20:00:54.088Z",
              "@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

accessToken

HTTPRequired

Body

application/json

issuerIdstringRequired

ID of the issuer where the pathway will be created

Example: 62aa04adf5afe00d0a6dac72

Responses

200

OK

application/jsonapplication/ld+json

pathwayIdstringOptionalExample: 66aa04adf5afe00d0a6dac72

issuerIdstringRequired

ID of the issuer where the pathway was created

Example: 62aa04adf5afe00d0a6dac72

draftStructureVersioninteger · int32Required

lastPublishedAtstring · date-timeOptional

draftLastUpdatedAtstring · date-timeRequired

creationDatestring · date-timeRequired

hasThirdPartyBadgesbooleanRequired

hasDraftChangesbooleanRequired

400

Bad Request

*/*

post

/v2/pathways

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
              "@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": "2026-03-06T20:00:54.088Z",
  "draftLastUpdatedAt": "2026-03-06T20:00:54.088Z",
  "creationDate": "2026-03-06T20:00:54.088Z",
  "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": "2026-03-06T20:00:54.088Z",
              "@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

accessToken

HTTPRequired

Path parameters

pathwayIdstringRequired

experienceIdstring · uuidRequired

Body

application/json

recipientone ofRequired

or

or

passedbooleanRequired

Responses

204

No Content

400

Bad Request

*/*

post

/v2/pathways/{pathwayId}/experience/{experienceId}/submit

HTTPcURLJavaScriptPython

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

accessToken

HTTPRequired

Path parameters

pathwayIdstringRequired

experienceIdstring · uuidRequired

Body

text/csv

stringOptionalExample: recipientId,passed email:[email protected],true

Responses

200

OK

application/jsonapplication/ld+json

400

Bad Request

*/*

post

/v2/pathways/{pathwayId}/experience/{experienceId}/submit-csv

HTTPcURLJavaScriptPython

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

accessToken

HTTPRequired

Path parameters

idstringRequired

Responses

200

OK

application/jsonapplication/ld+json

pathwayIdstringOptionalExample: 66aa04adf5afe00d0a6dac72

issuerIdstringRequired

ID of the issuer where the pathway was created

Example: 62aa04adf5afe00d0a6dac72

draftStructureVersioninteger · int32Required

lastPublishedAtstring · date-timeOptional

draftLastUpdatedAtstring · date-timeRequired

creationDatestring · date-timeRequired

hasThirdPartyBadgesbooleanRequired

hasDraftChangesbooleanRequired

400

Bad Request

*/*

get

/v2/pathways/{id}/versions/published

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
  "draftLastUpdatedAt": "2026-03-06T20:00:54.088Z",
  "creationDate": "2026-03-06T20:00:54.088Z",
  "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": "2026-03-06T20:00:54.088Z",
              "@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

accessToken

HTTPRequired

Path parameters

idstringRequired

Responses

200

OK

application/jsonapplication/ld+json

pathwayIdstringOptionalExample: 66aa04adf5afe00d0a6dac72

issuerIdstringRequired

ID of the issuer where the pathway was created

Example: 62aa04adf5afe00d0a6dac72

draftStructureVersioninteger · int32Required

lastPublishedAtstring · date-timeOptional

draftLastUpdatedAtstring · date-timeRequired

creationDatestring · date-timeRequired

hasThirdPartyBadgesbooleanRequired

hasDraftChangesbooleanRequired

400

Bad Request

*/*

post

/v2/pathways/{id}/versions/published

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
  "draftLastUpdatedAt": "2026-03-06T20:00:54.088Z",
  "creationDate": "2026-03-06T20:00:54.088Z",
  "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": "2026-03-06T20:00:54.088Z",
              "@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

accessToken

HTTPRequired

Path parameters

idstringRequired

Responses

200

OK

application/jsonapplication/ld+json

pathwayIdstringOptionalExample: 66aa04adf5afe00d0a6dac72

issuerIdstringRequired

ID of the issuer where the pathway was created

Example: 62aa04adf5afe00d0a6dac72

draftStructureVersioninteger · int32Required

lastPublishedAtstring · date-timeOptional

draftLastUpdatedAtstring · date-timeRequired

creationDatestring · date-timeRequired

hasThirdPartyBadgesbooleanRequired

hasDraftChangesbooleanRequired

400

Bad Request

*/*

post

/v2/pathways/{id}/versions/draft/revert

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
  "draftLastUpdatedAt": "2026-03-06T20:00:54.088Z",
  "creationDate": "2026-03-06T20:00:54.088Z",
  "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": "2026-03-06T20:00:54.088Z",
              "@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

accessToken

HTTPRequired

Path parameters

idstringRequired

Body

application/json

groupIdsToAddstring[]RequiredExample: 61aa04adf5afe00d0a6dac72

groupIdsToRemovestring[]RequiredExample: 67aa04adf5afe00d0a6dac72

Responses

200

OK

No content

400

Bad Request

*/*

post

/v2/pathways/{id}/subscriptions

HTTPcURLJavaScriptPython

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

accessToken

HTTPRequired

Path parameters

idstringRequired

Query parameters

recipientIdentifierstringRequired

Identifier of the recipient, format: recipientType:recipientId

Example: email:[email protected]

Responses

200

OK

application/jsonapplication/ld+json

idstringRequiredExample: 61aa04adf5afe00d0a6dac72

pathwayIdstringRequiredExample: 66aa04adf5afe00d0a6dac72

400

Bad Request

*/*

get

/v2/pathways/{id}/recipient-progress

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
    "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": "2026-03-06T20:00:54.088Z",
                "@type": "completed"
              },
              "evaluatedAt": "2026-03-06T20:00:54.088Z"
            }
          ],
          "inProgressCriteria": [
            {
              "lms": "CANVAS",
              "domain": "text",
              "courseId": "text",
              "completionRequirement": {
                "doNotAwardBefore": "2026-03-06T20:00:54.088Z",
                "@type": "completed"
              },
              "evaluatedAt": "2026-03-06T20:00:54.088Z"
            }
          ]
        },
        "experienceProgress": {
          "evaluations": [
            {
              "experienceId": "123e4567-e89b-12d3-a456-426614174000",
              "passed": true,
              "lastEvaluatedAt": "2026-03-06T20:00:54.088Z"
            }
          ]
        }
      }
    }
  }
}

Get progress status for the recipient group

get

Authorizations

accessToken

HTTPRequired

Path parameters

idstringRequired

recipientGroupIdstringRequired

Responses

200

OK

application/jsonapplication/ld+json

idstringRequiredExample: 61aa04adf5afe00d0a6dac72

pathwayIdstringRequiredExample: 66aa04adf5afe00d0a6dac72

400

Bad Request

*/*

get

/v2/pathways/{id}/recipient-groups/{recipientGroupId}/progress

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
    "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": "2026-03-06T20:00:54.088Z",
                  "@type": "completed"
                }
              },
              "completed": 5
            }
          ]
        }
      }
    }
  }
}

Get aggregate progress status for the entire pathway

get

Authorizations

accessToken

HTTPRequired

Path parameters

idstringRequired

Responses

200

OK

application/jsonapplication/ld+json

idstringRequiredExample: 61aa04adf5afe00d0a6dac72

pathwayIdstringRequiredExample: 66aa04adf5afe00d0a6dac72

400

Bad Request

*/*

get

/v2/pathways/{id}/aggregate-progress

HTTPcURLJavaScriptPython

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": "2026-03-06T20:00:54.088Z",
    "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": "2026-03-06T20:00:54.088Z",
                  "@type": "completed"
                }
              },
              "completed": 5
            }
          ]
        }
      }
    }
  }
}

List all pathways for the issuer

get

Required scopes

This endpoint requires the following scopes:

• : Award badges and update your issuers

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Responses

200

OK

application/jsonapplication/ld+json

400

Bad Request

*/*

get

/v2/issuers/{idOrEntityId}/pathways

HTTPcURLJavaScriptPython

GET /v2/issuers/{idOrEntityId}/pathways HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pathwayInfos": [
    {
      "pathwayId": "66aa04adf5afe00d0a6dac72",
      "issuerId": "62aa04adf5afe00d0a6dac72",
      "draftName": "Road",
      "publishedName": "Highway",
      "draftCompletionBadgeUrl": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
      "publishedCompletionBadgeUrl": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
      "subscribedGroupCount": 2,
      "uniqueMemberCount": 100,
      "pathwayGroupLtiToolCountsByLmsType": {
        "Canvas": 2,
        "Blackboard": 3,
        "Moodle": 4,
        "Other": 5
      }
    }
  ]
}

Delete pathway

delete

Authorizations

accessToken

HTTPRequired

Path parameters

idstringRequired

Responses

204

Pathway deleted

400

Bad Request

*/*

delete

/v2/pathways/{id}

HTTPcURLJavaScriptPython

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

No content