v1

latestOpenAPI 3.1.02026-07-122360148.3 KB

Courses

List Courses

Retrieve a list of course type learning objects.

These are collections of content type learning objects that are grouped together for a specific learning purpose.

get/unified/lms/courses

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,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields

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

updated_afterstring date-time nullable

Use a string with a date to only select results updated after that given date

external_referencestring nullable

Filter to select courses by external_reference

LMS Courses Filter

{
  "updated_after": "2020-01-01T00:00:00.000Z"
}

pagestring nullable

The page number of the results to fetch

page_sizestring nullable

The number of results per page (default value is 25)

nextstring nullable

The unified cursor

updated_afterstring date-time nullable

Example:2020-01-01T00:00:00.000Z

Use a string with a date to only select results updated after that given date

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 list of courses was retrieved.

next_pagestring nullable

nextstring nullable

totalnumber nullable

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",
      "content_ids": [
        "16873-SOFTWARE-ENG-COURSE",
        "16874-SOFTWARE-ENG-COURSE"
      ],
      "remote_content_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "title": "Software Engineer Lv 1",
      "description": "This course acts as learning content for software engineers.",
      "languages": [
        {
          "value": "en_GB"
        }
      ],
      "cover_url": "https://www.googledrive.com/?v=16873",
      "url": "https://www.linkedinlearning.com/?v=16873",
      "duration": "P3Y6M4DT12H30M5S",
      "categories": [
        {
          "id": "12345",
          "name": "Technology"
        }
      ],
      "skills": [
        {
          "id": "12345",
          "name": "Sales Techniques"
        }
      ],
      "provider": "Course Provider",
      "authors": [
        {
          "id": "123",
          "name": "John Doe"
        }
      ],
      "updated_at": "2021-07-21T14:00:00.000Z",
      "created_at": "2021-07-21T14:00:00.000Z"
    }
  ]
}

All 23 operations