Canvas Credentials 2025 API Change Log

[#1]

This document provides an overview of recent updates and enhancements to the Canvas Credentials API. The heading date indicates the date that the API code was made available in the production environment.

2025-03-10

Announcement Date: 2025-03-13

API wide changes:

• To provide greater flexibility and consistency, most API endpoints now accept both the internal ID (found in the URL after login, e.g., /issuers/644f6f907b1e2769a88a2632) and the public entity ID (in public page URLs: public/issuers/d9xPfJ2rTOGPItinZWRa6w) for issuers, badge classes, assertions, and users. This allows you to interact with entities using the method that best suits your workflow, provided you have the necessary permissions.

Issuer updates:

• Existing GET endpoints:
  • New fields:
    • badgeSkillLinkingPreferences
• Existing GET/POST/PUT/PATCH endpoints:
  • New fields:
    • preferences.customPropertyDefinitions
    • preferences.defaultPrintCertTemplateId
    • preferences.enabledPrintCertTemplateIds

BadgeClass updates:

• New endpoint:
  • /v2/badgeclasses{entityId}/duplicate
• Existing GET/POST/PUT/PATCH endpoints:
  • New fields:
    • preferences.includeOnPublicPages
    • preferences.customPropertyValues
    • preferences.enabledPrintCertTemplateIds
    • preferences.defaultPrintCertTemplateId
    • ob3properties

For detailed information on these changes, including request and response examples, please refer to the updated API documentation: https://api.badgr.io

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

2025-02-20

Announcement Date: 2025-02-24

Improved Organization and Issuer Management

The API is expanded with a new endpoint and an enhancement to issuer creation, improving organization management efficiency for administrators.

Addition

Issuer

• GET /v2/organizations Endpoint – Lists all organizations where the authenticated user has admin privileges, providing better visibility and control over managed organizations.

Extended 

Organization

• POST /v2/issuers Endpoint – Now supports an optional organizationId parameter. When specified, the newly created issuer is automatically associated with the given organization, streamlining the setup process. This requires organization write permissions.

These updates improve how administrators interact with organizations and issuers through API. For full details, see the public API documentation.