Instructure Developer Documentation Portal

Badgeclasses

Last updated 18 days ago

Was this helpful?

delete

DELETE /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Accept: */*

204

BadgeClass deleted

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {}
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

delete

DELETE /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode} HTTP/1.1
Host: api.badgr.io
Accept: */*

204

No Content

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {}
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

get

GET /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

delete

DELETE /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badgr.io
Accept: */*

204

BadgeClass deleted

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {}
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

get

GET /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badgr.io
Accept: */*

200

List of Assertions

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "entityType": "Assertion",
      "id": "6116c84d1ff787222b6c4d15",
      "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
      "openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
      "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "image": "https://api.badgr.io/public/assertions/SsCfI7FlTr6hAJe4irXnfQ/image",
      "recipient": {
        "identity": "sha256$4c2657856f",
        "hashed": true,
        "type": "email",
        "salt": "jgsu868",
        "plaintextIdentity": "jane.doe@example.com"
      },
      "issuedOn": "2025-04-24T23:51:13.745Z",
      "narrative": "text",
      "evidence": [
        {
          "url": "https://example.com",
          "narrative": "text",
          "name": "text",
          "description": "text",
          "genre": "text",
          "audience": "text"
        }
      ],
      "revoked": true,
      "revocationReason": "text",
      "acceptance": "Unaccepted",
      "expires": "2025-04-24T23:51:13.745Z",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "assertionRef": {
        "assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
      },
      "badgeRef": {
        "badgeUrl": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg"
      },
      "issuerRef": {
        "issuerUrl": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw"
      },
      "pending": true,
      "source": "local",
      "sourceUrl": "https://example.com/assertions/1",
      "originalJson": "{}",
      "imagePath": "uploads/badges/assertion-lY1LJ6K4RqG7ThGLYvWNng.png",
      "ob3AwardProperties": {
        "activityStart": "2025-04-24T23:51:13.745Z",
        "activityEnd": "2025-04-24T23:51:13.745Z",
        "licenseNumber": "text",
        "role": "text"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

get

GET /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

get

GET /v2/badgeclasses HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

get

GET /v2/badgeclasses/{idOrEntityId}/claim-codes HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "code": "5678945",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "label": "Conference Event",
      "limit": 10,
      "expirationDate": "2025-04-24T23:51:13.745Z",
      "enabled": true,
      "claimCount": 1,
      "claimUrl": "text"
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

post

POST /v2/badgeclasses/reactivate/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

post

POST /v2/badgeclasses/reactivate/ref/{ref} HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

patch

PATCH /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/enable HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "code": "5678945",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "label": "Conference Event",
      "limit": 10,
      "expirationDate": "2025-04-24T23:51:13.745Z",
      "enabled": true,
      "claimCount": 1,
      "claimUrl": "text"
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

patch

PATCH /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/disable HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "code": "5678945",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "label": "Conference Event",
      "limit": 10,
      "expirationDate": "2025-04-24T23:51:13.745Z",
      "enabled": true,
      "claimCount": 1,
      "claimUrl": "text"
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

get

GET /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Accept: */*

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

put

PUT /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 974

{
  "name": "Math Expert",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "achievementType": "Course",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "criteriaNarrative": "text",
  "tags": [
    "text"
  ],
  "alignments": [
    {
      "targetName": "text",
      "targetUrl": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetCode": "text",
      "displayAsSkill": true
    }
  ],
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "includeOnPublicPages": true,
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "stringValue": "text",
        "doubleValue": 1,
        "arrayValue": [
          "text"
        ],
        "public": true
      }
    ],
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
  }
}

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

put

PUT /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "label": "Conference Event",
  "limit": 10,
  "expirationDate": "2025-04-24T23:51:13.745Z"
}

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "code": "5678945",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "label": "Conference Event",
      "limit": 10,
      "expirationDate": "2025-04-24T23:51:13.745Z",
      "enabled": true,
      "claimCount": 1,
      "claimUrl": "text"
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

put

PUT /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 974

{
  "name": "Math Expert",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "achievementType": "Course",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "criteriaNarrative": "text",
  "tags": [
    "text"
  ],
  "alignments": [
    {
      "targetName": "text",
      "targetUrl": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetCode": "text",
      "displayAsSkill": true
    }
  ],
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "includeOnPublicPages": true,
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "stringValue": "text",
        "doubleValue": 1,
        "arrayValue": [
          "text"
        ],
        "public": true
      }
    ],
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
  }
}

200

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

post

POST /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 650

{
  "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
  "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
  "issuedOn": "2025-04-24T23:51:13.745Z",
  "recipient": {
    "identity": "jane.doe@example.com",
    "type": "email",
    "hashed": true
  },
  "allowDuplicateAwards": true,
  "narrative": "text",
  "evidence": [
    {
      "url": "https://example.com",
      "narrative": "text",
      "name": "text",
      "description": "text",
      "genre": "text",
      "audience": "text"
    }
  ],
  "extensions": {
    "value": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "expires": "2025-04-24T23:51:13.745Z",
  "ob3AwardProperties": {
    "activityStart": "2025-04-24T23:51:13.745Z",
    "activityEnd": "2025-04-24T23:51:13.745Z",
    "licenseNumber": "text",
    "role": "text"
  }
}

201

Created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "entityType": "Assertion",
      "id": "6116c84d1ff787222b6c4d15",
      "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
      "openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
      "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "image": "https://api.badgr.io/public/assertions/SsCfI7FlTr6hAJe4irXnfQ/image",
      "recipient": {
        "identity": "sha256$4c2657856f",
        "hashed": true,
        "type": "email",
        "salt": "jgsu868",
        "plaintextIdentity": "jane.doe@example.com"
      },
      "issuedOn": "2025-04-24T23:51:13.745Z",
      "narrative": "text",
      "evidence": [
        {
          "url": "https://example.com",
          "narrative": "text",
          "name": "text",
          "description": "text",
          "genre": "text",
          "audience": "text"
        }
      ],
      "revoked": true,
      "revocationReason": "text",
      "acceptance": "Unaccepted",
      "expires": "2025-04-24T23:51:13.745Z",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "assertionRef": {
        "assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
      },
      "badgeRef": {
        "badgeUrl": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg"
      },
      "issuerRef": {
        "issuerUrl": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw"
      },
      "pending": true,
      "source": "local",
      "sourceUrl": "https://example.com/assertions/1",
      "originalJson": "{}",
      "imagePath": "uploads/badges/assertion-lY1LJ6K4RqG7ThGLYvWNng.png",
      "ob3AwardProperties": {
        "activityStart": "2025-04-24T23:51:13.745Z",
        "activityEnd": "2025-04-24T23:51:13.745Z",
        "licenseNumber": "text",
        "role": "text"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

post

POST /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 1010

{
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "name": "Math Expert",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "achievementType": "Course",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "criteriaNarrative": "text",
  "tags": [
    "text"
  ],
  "alignments": [
    {
      "targetName": "text",
      "targetUrl": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetCode": "text",
      "displayAsSkill": true
    }
  ],
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "includeOnPublicPages": true,
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "stringValue": "text",
        "doubleValue": 1,
        "arrayValue": [
          "text"
        ],
        "public": true
      }
    ],
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
  }
}

201

Created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

post

POST /v2/badgeclasses HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 975

{
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "name": "Math Expert",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "image": "https://example.com/images/1",
  "achievementType": "Course",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "criteriaNarrative": "text",
  "tags": [
    "text"
  ],
  "alignments": [
    {
      "targetName": "text",
      "targetUrl": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetCode": "text",
      "displayAsSkill": true
    }
  ],
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "includeOnPublicPages": true,
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "stringValue": "text",
        "doubleValue": 1,
        "arrayValue": [
          "text"
        ],
        "public": true
      }
    ],
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
  }
}

201

BadgeClass created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-24T23:51:13.745Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

post

POST /v2/badgeclasses/{idOrEntityId}/duplicate HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "newName": "Badgeclass Copy"
}

201

BadgeClass created

{
  "id": "68e9d238c5afe622816febb3",
  "entityType": "BadgeClass",
  "entityId": "iOMWsaF1QbmMCofM54JlUg",
  "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
  "sourceUrl": "https://example.com/badge-classes/1",
  "originalJson": "{}",
  "createdAt": "2025-04-24T23:51:13.745Z",
  "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
  "name": "Math Expert",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "achievementType": "Course",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "criteriaNarrative": "text",
  "alignments": [
    {
      "targetName": "text",
      "targetUrl": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetCode": "text",
      "displayAsSkill": true
    }
  ],
  "tags": [
    "text"
  ],
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "source": "local",
  "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
  "archived": true,
  "archivedDate": "2025-04-24T23:51:13.745Z",
  "archivalNote": "text",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "includeOnPublicPages": true,
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "stringValue": "text",
        "doubleValue": 1,
        "arrayValue": [
          "text"
        ],
        "public": true
      }
    ],
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
  }
}

post

POST /v2/badgeclasses/{idOrEntityId}/claim-codes HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "label": "Conference Event",
  "limit": 10,
  "expirationDate": "2025-04-24T23:51:13.745Z"
}

201

Created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "code": "5678945",
      "createdAt": "2025-04-24T23:51:13.745Z",
      "label": "Conference Event",
      "limit": 10,
      "expirationDate": "2025-04-24T23:51:13.745Z",
      "enabled": true,
      "claimCount": 1,
      "claimUrl": "text"
    }
  ],
  "timestamp": "2025-04-24T23:51:13.745Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Badgeclasses

Badgeclasses

Delete a BadgeClass

Archive a ClaimCode for a BadgeClass

Get a single BadgeClass

Delete a BadgeClass

Get list of Assertions for the specified scope

Get a list of BadgeClasses for a single Issuer

Get a list of BadgeClasses for authenticated user

Get a list of ClaimCodes for a single BadgeClass

Reactivate a BadgeClass by id

Reactivate a BadgeClass by ref

Enable a disabled ClaimCode for a BadgeClass

Disable an enabled ClaimCode for a BadgeClass

Get a single BadgeClass

Update an existing BadgeClass.

Update an existing ClaimCode for a BadgeClass

Update an existing BadgeClass.

Issue a new Assertion to a recipient

Create a new BadgeClass associated with an Issuer

Create a new BadgeClass

Duplicate a BadgeClass

Create a new ClaimCode for a BadgeClass