Sign in

v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
Recommended Learning

Get All Recommended Learning Items

This endpoint retrieves all recommended learning items for the current organization. The recommended learning endpoint requires a start and end date, with a maximum range of 7 days.<br><br>For Global Admin Tool Organizations, if the X-Degreed-Organization-Code header is included, the endpoint will return learning items for the Tenant Organization related to the header value as long as the organization is a member of the Global Admin Tool Organization. <h3>Required Scope</h3>recommended_learning:read or recommended_learning:write

get/api/v2/recommended-learning

Query parameters

filter[start_date]string date required

Filter criteria that returns learning items that were recommended on this date or later. Format yyyy-mm-dd.

filter[end_date]string date required

Filter criteria that returns learning items that were recommended before this date. Format yyyy-mm-dd.

nextstring

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

limitinteger

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

Headers

X-Degreed-Organization-Codestring
Example:tenant_organization_code

For Global Admin Tool Organizations, include this header in your request to retrieve learning items from 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

{
  "links": {
    "self": "https://api.betatest.degreed.com/api/v2/recommended-learning"
  },
  "data": [
    {
      "type": "recommended-learning",
      "id": "KZ0L9n",
      "attributes": {
        "assignment-type": "RecommendedLearning",
        "status": "Pending"
      },
      "links": {
        "self": "https://api.betatest.degreed.com/api/v2/recommended-learning/KZ0L9n"
      },
      "relationships": [
        {
          "user": {
            "data": {
              "id": "zRewa",
              "type": "users"
            }
          },
          "content": {
            "data": {
              "id": "nNmwVAgd",
              "type": "content"
            }
          },
          "provider": {
            "data": {
              "id": "degreedopenlibrary",
              "type": "providers"
            }
          },
          "assigner": {
            "data": {
              "id": "Q5KpZ",
              "type": "users"
            }
          }
        }
      ],
      "included": [
        {
          "type": "content",
          "id": "nNmwVAgd",
          "attributes": {
            "content-type": "Video",
            "url": "https://www.youtube.com/watch?v=D33PakstpjI",
            "title": "The Learning Algorithm Using AI to Expand Workforce Learning",
            "provider": "degreedopenlibrary",
            "degreed-url": "https://api.betatest.degreed.com/videos/?d=DP6ZLZKYNP"
          },
          "links": {
            "self": "/content/nNmwVAgd"
          }
        }
      ]
    }
  ]
}