v1

latestOpenAPI 3.1.02026-07-122360148.3 KB

Content

Get Content

Retrieve a content type learning object by its identifier.

These are the most granular learning objects (e.g. video, document, podcast) on a platform.

Only content objects for which the platform supports progress and completion tracking are returned.

get/unified/lms/content/{id}

Path parameters

idstring required

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable

Example:id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The content with the given identifier was retrieved.

Example response

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1",
    "course_ids": [
      "16873-SOFTWARE-ENG-COURSE",
      "16874-SOFTWARE-ENG-COURSE"
    ],
    "remote_course_ids": [
      "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
    ],
    "title": "Software Engineer Lv 1",
    "description": "This video acts as learning content for software engineers.",
    "languages": [
      {
        "value": "en_GB"
      }
    ],
    "content_url": "https://www.youtube.com/watch?v=16873",
    "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873",
    "cover_url": "https://www.googledrive.com/?v=16873",
    "duration": "P3Y6M4DT12H30M5S",
    "categories": [
      {
        "id": "12345",
        "name": "Technology"
      }
    ],
    "skills": [
      {
        "id": "12345",
        "name": "Sales Techniques"
      }
    ],
    "order": 1,
    "provider": "Content Provider",
    "short_description": "This course is a valuable resource and acts as learning content for...",
    "localizations": [
      {
        "title": "Software Engineer Lv 1",
        "description": "This video acts as learning content for software engineers.",
        "languages": {
          "value": "en-US",
          "source_value": "string"
        }
      }
    ],
    "tags": [
      "Sales Techniques",
      "Customer Service"
    ],
    "authors": [
      {
        "id": "123",
        "name": "John Doe"
      }
    ],
    "updated_at": "2021-07-21T14:00:00.000Z",
    "created_at": "2021-07-21T14:00:00.000Z"
  }
}