Overview
The Credly platform allows organizations to use OAuth 2.0 to access the Credly system. This is done through the
client_credentials grant type, which allows your application to access the Credly API. OAuth 2.0 can be used
alongside, or in place of, our existing authorization token system.
Creating an OAuth Application
In order to use OAuth 2.0 with the Credly system, the first step is to have an OAuth application created for your organization. To set this up, please contact your Credly representative, and let them know that you'd like to integrate via OAuth. An OAuth application will be created for you, and your representative will share the client ID and client secret needed to make requests.
OAuth Scopes
Credly supports the following OAuth scopes. Any combination of these can be requested when generating an access token.
| Name | Description |
|---|---|
| authorization_tokens | For creating, managing, and deleting authorization tokens. |
| badge_templates | See, create, edit, archive and delete your badge templates |
| events | For reading webhook events relevant to your organization |
| invitations | For inviting additional users to your organization |
| issued_badges | Read, issue, replace, revoke and delete badges |
| memberships | For viewing and managing your organization's memberships |
| recommendations | See, create, update, and delete recommendations |
| workforce | Read, create, invite, update, and delete employee records |
Generating Access Tokens
Request
Once you have the client ID and client secret, you can generate an access token by making a request
to the following endpoint. Note that this endpoint does not use the api.credly.com domain, but instead uses www.credly.com.
POST https://www.credly.com/oauth/token
Parameters
| Name | Description |
|---|---|
| client_id | Required. This is the Client ID you got when you registered your application, above. |
| client_secret | Required. This is the Client Secret you got when you registered your application, above. |
| grant_type |
Required. Must be the string client_credentials. |
| scope | Required. A space-separated list of scopes. See OAuth Scopes for more information |
Response
A successful request will return a JSON response including the access token:
{
"access_token": "IpsPAjhpm1RjCx30ggTpx2xXmHKUpmZcQbcKkecpxWs",
"token_type": "Bearer",
"expires_in": 7200,
"scope": "issued_badges",
"created_at": 1739996399
}
Accessing the Credly API
After obtaining an access token from the endpoint above, you can use it to access the Credly API.
To do this, include the access token in the Authorization header of your request, along with the Bearer prefix.
GET `/organizations/<organization_id>/badges`
Authorization: Bearer [access token]