v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
User

Get Required Learning for a Specific User

This endpoint retrieves all required learning for a specific user. You can retrieve a user by specifying the ID as a path parameter or specifying an identifier as a query string URL parameter. For example, https://api.betatest.degreed.com/api/v2/users/<email_value>/required-learning?identifier=email<br><br>For Global Admin Tool Organizations, if the user belongs to a Tenant Organization, then the X-Degreed-Organization-Code header must be provided.<h3>Required Scope</h3>users:read, users:write, required_learning:read or required_learning:write

get/api/v2/users/{id}/required-learning

Path parameters

idstring required

The ID of the user to retrieve.

Query parameters

limitinteger

The maximum number of required learning items to display per page. A maximum of 1000 is allowed.

nextstring

Retrieves the next batch of required learning items. This value expires after 2 minutes if a request has not been made during that time.

identifierstring

How to identify the user. The identifier can be id (default), employee-id, or email and must be used as a query string URL parameter. For example, https://api.betatest.degreed.com/api/v2/users/<email_value>/required-learning?identifier=email

Headers

X-Degreed-Organization-Codestring
Example:tenant_organization_code

For Global Admin Tool Organizations, include this header in your request to retrieve required learning items for the specified user in the tenant organization. You must provide your organization code as the value. Contact your Degreed technical partner if you are unsure what your organization code is.

Response

Success

Example response

{
  "data": [
    {
      "type": "required-learning",
      "relationships": [
        {
          "content": {
            "data": {
              "type": "content"
            }
          },
          "provider": {
            "data": {
              "type": "providers"
            }
          },
          "required-learning-collection": {
            "data": {
              "type": "required-learning-collection"
            }
          },
          "user": {
            "data": {
              "id": "x4jEW2",
              "type": "users"
            }
          },
          "assigner": {
            "data": {
              "type": "users"
            }
          }
        }
      ]
    }
  ]
}