v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

RequiredLearning

Get a Specific Required Learning

This endpoint retrieves a specific required learning item. <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 or required_learning:write

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

Path parameters

idstring required

The ID of the required learning item to retrieve.

Headers

X-Degreed-Organization-Codestring

Example:tenant_organization_code

For Global Admin Tool Organizations, this header can be included in your request to get required learning items for the tenant organization, but it is not required. 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": {
    "relationships": [
      {
        "content": {
          "data": {
            "type": "content"
          }
        },
        "provider": {
          "data": {
            "type": "providers"
          }
        },
        "required-learning-collection": {
          "data": {
            "type": "required-learning-collection"
          }
        },
        "assigner": {
          "data": {
            "type": "users"
          }
        }
      }
    ]
  }
}