CINXE.COM

<!DOCTYPE html> <html class='legacy-css' lang='en'> <head> <meta charset='UTF-8'> <script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" charset="UTF-8" data-domain-script="47d1c5ce-460c-434d-8cc7-0318d7d02a9d" ></script> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ function OptanonWrapper() { } //]]> </script> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ window._trackJs = { token: 'e43bb3a0b11a469ba1ef2ec2b79c6b11', application: 'acclaim-production', version: '1.115.0'}; //]]> </script><script type="text/javascript" src="https://cdn.trackjs.com/releases/current/tracker.js"></script> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ (function(apiKey){ (function(p,e,n,d,o){var v,w,x,y,z;o=p[d]=p[d]||{};o._q=[]; v=['initialize','identify','updateOptions','pageLoad'];for(w=0,x=v.length;w < x;++w)(function(m){ o[m]=o[m]||function(){o._q[m===v[0]?'unshift':'push']([m].concat([].slice.call(arguments,0)));};})(v[w]); y=e.createElement(n);y.async=!0;y.src='https://cdn.pendo.io/agent/static/'+apiKey+'/pendo.js'; z=e.getElementsByTagName(n)[0];z.parentNode.insertBefore(y,z);})(window,document,'script','pendo'); })("65460ef3-56d0-45a3-7b3b-fe1ec0463054") //]]> </script> <meta content='Credly is a global Open Badge platform that closes the gap between skills and opportunities. We work with academic institutions, corporations, and professional associations to translate learning outcomes into digital credentials that are immediately validated, managed, and shared.' name='description'> <meta content='Credly badges, Credly, Acclaim, open badges, digital badges, badges, web-enabled credentials, Badge Alliance, Mozilla Open Badge standards, Mozilla Open Badges, verified credentials, learning outcomes' name='keywords'> <meta content='width=device-width,initial-scale=1.0' name='viewport'> <meta content='1B97012E4CB3B07611090D1A0B4D9D19' name='msvalidate.01'> <meta content='d20lZjrSJJ_n0jc1HHlADZBDmn5wZfiBDucFzzOzHCY' name='google-site-verification'> <meta name="csrf-param" content="authenticity_token" /> <meta name="csrf-token" content="jH4Jz70sDFxtCPsdFtBYM_09ImkIn6cVpx3-ESKQ9ISzTFDHWJjfU0w6YNs4iBQroH5Q7b2uWv8Wdmakv-uKkg" /> <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Open+Sans:400,300,600,700" media="all" /> <link rel="stylesheet" href="//use.typekit.net/bcc0eop.css" media="all" /> <link as='font' crossorigin='crossorigin' href='https://cdn.credly.com/assets/icons-525b616afff484c26342b59ecf539e7dbc2fa6225a9c281ed81f52e345669b40.woff2' rel='preload'> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ (function(i,s,o,g,r,a,m) { i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-41547114-1', 'credly.com'); ga('require', 'displayfeatures'); ga('send', 'pageview'); //]]> </script><title>Developer API - Credly</title> <link rel="stylesheet" href="https://cdn.credly.com/assets/screen-24ed6a41e63909dd5bc6b6b26a86e832a0214c4193795e8e1023b11208947d11.css" media="all" /> </head> <body class=''> <div id='unsupported-browser-message'></div> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ pendo.initialize({"visitor":{},"account":{}}); //]]> </script><header id='website-header' style=''> <div class='website-header-main-links-container website-header-placeholder'></div> <div> <a href='#skip-target' id='skip-to-content'>Skip to content</a> </div> <div class='website-header-main-links-container non-react-header'> <div class='grid website-header-main-links'> <a class="acclaim-logo" href="https://www.credly.com/">Credly</a> <nav data-behavior='container' name='main_navigation'> <div class='header-nav-item header-nav-item--btn-container header-nav-item--btn-container--create-account-btn-container'> <a class='create-account-btn button white' href='/users/sign_up'> Create Account </a> </div> <div class='header-nav-item header-nav-item--btn-container header-nav-item--btn-container--sign-in-btn-container'> <a class='sign-in-btn button' href='/users/sign_in'> Sign In </a> </div> </nav> </div> </div> </header> <div class='search-bar search-bar--legacy' data-container='search-bar'></div> <div class='docs' id='flash'> <div class='grid'> <div class='l1-0 r1-0' data-behavior='flash-container'> <noscript> <div class='flash notice'> <i class='icon-error'></i> <div> We've detected that your browser has JavaScript disabled. Some features of Credly require Javascript to be enabled. For the best experience, please enable JavaScript in your browser settings or try using a different browser. </div> </div> </noscript> </div> </div> </div> <div id='docs-overview'> <div class='grid'> <main class='w10-11 l1-0 r1-0'> <div class='w10-9 l0-1 r0-1' id='skip-target'> <section class='intro'> <h1>Credly Developer API</h1> <p> Start with the basics by reading about how the Credly API works or jump right into writing code on our badge platform. The Credly REST API allows users to manage badges they have been issued and issue badges on behalf of organizations. </p> </section> <section class='explanation'> <table> <tr> <td> Organizations <strong>ISSUE</strong> badges for things they teach or facilitate. </td> <td> Users <strong>EARN</strong> badges when they showcase their professional skills. </td> <td> Users can share the badges they earn to <strong>BROADCAST</strong> their potential. </td> </tr> </table> </section> <section class='getting-started'> <a href='/docs/getting_started'> <h2>Getting Started with Credly</h2> <p> Get a basic walk-through on how Credly works and how you will integrate your users and achievements. You will also get an overview of how to use the web service API and all available features. </p> <span>Get Started</span> </a> </section> <section class='contents fix' data-behavior='act-like-a-table'> <a class='do-not-underline' href='/docs/web_service_api'> <h2 class='icon-docs-api'>Web Service API</h2> <p> Whether you're an expert developer or a beginner, integrating with the badges platform is easy. We offer a REST API that will allow you to quickly get started issuing badges from your organization. </p> <span class='do-underline'>Documentation »</span> </a> <a class='do-not-underline' href='/docs/organizations'> <h2 class='icon-docs-organizations'>Organizations</h2> <p> An organization is the entity associated with a user that is capable of issuing badges to a user. Once an organization has been created it may start creating badge templates and issuing badges to users. </p> <span class='do-underline'>Documentation »</span> </a> <a class='do-not-underline' href='/docs/badge_templates'> <h2 class='icon-docs-templates'>Badge Templates</h2> <p> A template for a badge that can be issued to a user. Each badge template contains a unique visual image and includes important data that links back to the issuer, as well as associated criteria and standards. </p> <span class='do-underline'>Documentation »</span> </a> <a class='do-not-underline' href='/docs/issued_badges'> <h2 class='icon-docs-issued-badges'>Issued Badges</h2> <p> Issued badges may come from multiple sources and may be displayed on a single profile. Issued badges may contain an expiration date, and may be revoked by the issuing organization. Issued badges may also be shared outside the Credly system. </p> <span class='do-underline'>Documentation »</span> </a> <a class='do-not-underline' href='/docs/workforce'> <h2 class='icon-activity-leadership'>Workforce</h2> <p> Organizations using Workforce may find utility in being able to programmatically create, update, delete, invite, or retrieve employees. These endpoints can be leveraged to enable integration between Workforce and an HR System. </p> <span class='do-underline'>Documentation »</span> </a> <a class='do-not-underline' href='/docs/obi_specified_endpoints'> <h2 class='icon-docs-obi'>OBI Specified Endpoints</h2> <p> The Open Badges Initiative is a new online standard to recognize and verify learning. OBI is an open technical standard any organization can use to create, issue and verify digital badges. </p> <span class='do-underline'>Documentation »</span> </a> </section> <section class='api-terms'> <a class='do-not-underline' href='https://info.credly.com/api-terms-of-service'> <span class='do-underline'>Credly API Terms of Service</span> </a> </section> </div> </main> </div> </div> <div data-container='global-search-results'></div> <footer id='footer' style=''> <div class='grid non-react-footer'> <section class='l1-0 r1-0 footer-margin'> <div class='links'> <div class='footer-link-wrapper'> <a class="footer-link" href="https://resources.credly.com/schedule-a-demo">Request Demo</a> </div> <div class='footer-link-wrapper'> <a class="footer-link" href="https://info.credly.com/about-us">About Credly</a> </div> <div class='footer-link-wrapper'> <a class="footer-link" href="https://info.credly.com/legal">Terms</a> </div> <div class='footer-link-wrapper'> <a class="footer-link" href="https://info.credly.com/privacy-policy">Privacy</a> </div> <div class='footer-link-wrapper'> <a class="footer-link" href="/docs">Developers</a> </div> <div class='footer-link-wrapper'> <a class="footer-link" href="/support">Support</a> </div> </div> <div class='cookie-links'> <div class='cookie-link-wrapper'> <a class="footer-link" target="_blank" href="https://info.credly.com/cookie-policy">Cookies</a> </div> <div class='cookie-link-wrapper'> <a class="footer-link" target="_blank" href="https://info.credly.com/cookie-policy">Do Not Sell My Personal Information</a> </div> </div> <div class='app-store-links'> <a class='app-store-link app-store-link-google' href='https://play.google.com/store/apps/details?id=com.credly.android'></a> <a class='app-store-link app-store-link-apple' href='https://apps.apple.com/us/app/credly/id1630234370'></a> </div> </section> </div> </footer> <div aria-live='assertive' class='sr-only' data-behavior='screen-reader-announcements' role='alert'> <span></span> </div> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ (function(){ document.addEventListener('click', function(e){ var eventTarget = e.target; if (eventTarget.id == 'skip-to-content' || eventTarget.id == 'skip-nav'){ var href, target; href = eventTarget.getAttribute('href').substr(1); target = document.getElementById(href); if (!target.getAttribute('tabindex')){ target.setAttribute('tabindex', '-1'); } target.focus(); } }); })(); //]]> </script><script src="https://cdn.credly.com/assets/legacy_application-527398018ad937dc8dfd828af038cabe92583c028a506df70e6afcc65a037176.js" crossorigin="anonymous"></script> <script src="https://cdn.credly.com/assets/utilities/set_time_zone_cookie-aca1fcb79ea4e90d8e963d7850b867a9bbeb077b05a6cad141c1ce7d945fd20d.js" crossorigin="anonymous"></script> <script src="https://cdn.credly.com/assets/utilities/set_supported_browser_flag-4358d3fc13a018a9a17a468d8a96f4ea4cb8b3489224d4c4e3fc6b23b9e09f45.js" crossorigin="anonymous"></script> <script nonce="+MpfshBWX6GqVD6GyuUBD3EZSm4fo8KF1IabY5Wnj4w="> //<![CDATA[ (function(){ if (typeof(App) !== 'undefined' && App.Behaviors && App.Behaviors.TrackStat) { App.Behaviors.TrackStat.init( {"url":"https:\/\/stats.credly.com\/stats\/interaction","request_data":{"session_id":"ee92e6b6-2db6-40b7-be35-452ed483da4f","flexible_params_auth":["snapshot_json","stat_object_id","stat_object_type","stat_type"],"auth_version":"1.0","auth_key":"user:8d768abb-4e6a-4f38-8cb3-86dc95196f75","auth_timestamp":"1732389629","auth_signature":"af5510756a8aa1090bc24b7f1fa917d06412ef915a78ffbf65be8c1c374d7bd5"}}, null ); } })(); //]]> </script><script src="https://cdn.credly.com/assets/utilities/warn_unsupported_browsers-74a87b5eae33bb6b05d13d276a337fcfb531f763344fa6bb30b70ecbf01cb3e2.js" crossorigin="anonymous"></script> </body> </html>