v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

RequiredLearning

Get All Required Learning Items

This endpoint retrieves all required learning items for the current organization. The required learning endpoint requires a start and end date, with a maximum range of 7 days.<br><br>Note: Information on completed items is not retrieved unless you use the filter[status] URL parameter. <br><br>For Global Admin Tool Organizations, if the X-Degreed-Organization-Code header is included, the endpoint will return required 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>required_learning:read

get/api/v2/required-learning

Query parameters

filter[start_date]string date required

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

filter[end_date]string date required

Filter criteria that returns learning items that were created, or modified before this date. Format yyyy-mm-dd.

filter[status]string

Filter criteria that returns learning items by status. Status options include Pending, Queued, Dismissed, and Complete. <br><br>Note: To retrieve information on completed items, you must use this filter.

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.

limitinteger

The maximum number of required 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 required 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

{
  "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"
            }
          }
        }
      ]
    }
  ]
}