Getting Started with the API

The Degreed API allows you to manage the data contained within Degreed using HTTP requests. Organizations often use the API to update user records, add content to Degreed, and so on.

In order to use the Degreed API, you must authenticate. Degreed uses OAuth 2.0 bearer access tokens for authentication and authorization. Scopes are used to control sets of operations and resources that an access token permits.

To get started with the Degreed API, you must obtain OAuth API keys, request an access token, and invoke the API methods using HTTP requests.

Step 1: Obtain API Keys

You can obtain API keys (Client ID and Client Secret credentials) using the administrator's dashboard or by contacting your Degreed Technical Solutions Specialist. Use these credentials to request a bearer access token.

❗️

When Creating API Keys, Use Minimal Viable Scopes

When you create API keys, you assign scopes to them. These scopes indicate the endpoints accessible to access_tokens created with the API key. As a general data security principle, we highly recommend that you make your API keys with a minimal number of scopes to enable your integration work to succeed. This approach minimizes the possible harm from compromised keys or tokens.

Step 2: Request an Access Token

Use the credentials from Step 1 to generate an access token. Send an HTTP POST request with the parameters and relevant scopes described in Authentication Guide with an API client such as Postman or Insomnia, or you can use the command line. Access tokens are valid only for the set of operations and resources described in the scope of the token request. Refer to the documentation for each API call for the required scopes.

The OAuth base URL you use to make the request depends on the environment (betatest or production) and data center (US, EU, or CA) you are using. For more information, see Authentication Guide.

🚧

The access token base URL is not the same as the API base URL used to submit requests.

Step 3: Submit an HTTP Request

Use an API client such as Postman or Insomnia to make an HTTP request. The base URL you use to make the request depends on the environment (betatest or production) and data center (US, EU, or CA) you are using. You must include your bearer access token in the Authorization header in the API calls.

Use the following base URLs when submitting requests:


Did this page help you?