Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Integrations

Retrieve an external course

🔑

Required OAuth scope: integrations:read.

Retrieves the details of a specific course with the provided external platform course ID.

get/api/v2/integrations/{integrationId}/courses/{externalId}

Path parameters

integrationIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the integration the course has been imported for.

externalIdstring required
Example:a3215H-7

The unique external ID of the course.

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns the details of the given external course.

defaultLang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'zh' | 'am_ET' | 'bn' | 'bs' | 'ca' | 'cy' | 'en_CA' | 'en_GB' | 'es_AR' | 'es_MX' | 'et' | 'fr_CA' | 'gu' | 'he_IL' | 'hy' | 'kk' | 'km' | 'lo' | 'lv' | 'mi' | 'mn_MN' | 'mr' | 'ms' | 'my_MM' | 'nn_NO' | 'or' | 'pa' | 'pt_BR' | 'pt_MZ' | 'rn_BI' | 'si' | 'ta' | 'te' | 'tl_PH' | 'ur' | 'uz' | 'yo_NG' | 'zh_tw' | 'el' | 'hi' | 'sr' | 'ar' | 'vi' | 'zh_HANT' required

The language of the external course which is displayed by default when the learner’s profile language is not available. The name, description, subjects, launchUrl, and mobileLaunchUrl values must be coherent with this language.

externalIdstring required

The unique external ID of the external course.

launchUrlstring required

The URL to launch and play the external course.

namestring required

The title of the external course.

subjectsstring[] required

The list of subjects of the external course.

contentType'article' | 'assessment' | 'audiobook' | 'book' | 'certificate' | 'channel' | 'course' | 'curriculum' | 'interactive' | 'journey' | 'labs' | 'linkedContent' | 'mooc' | 'podcast' | 'program' | 'roleplay' | 'specialization' | 'topvoice' | 'video'

The type of the external course. If not set, course type is used.

descriptionstring

The description of the external course.

difficultyLevel'advanced' | 'beginner' | 'intermediate'

The level of difficulty of the external course.

durationinteger

The duration of the external course, in minutes.

imageUrlstring

The URL of the image of the external course.

mobileLaunchUrlstring

The URL to launch and play the external course from a mobile. If not set, the launchUrl is used.

authorIdstring ObjectId required

The unique ID of the author.

courseIdstring ObjectId required

The unique ID of the course created from this external course.

Example response

{
  "externalId": "l3ssup3rh3r0s",
  "launchUrl": "https://player.mylearningplatform.com/launch/l3ssup3rh3r0s",
  "name": "Machine Learning Crash Course",
  "sources": [
    {
      "name": "Wikipedia",
      "logoUrl": "https://en.wikipedia.org/static/images/icons/wikipedia.png"
    }
  ],
  "subjects": [
    "Machine Learning",
    "IT"
  ],
  "description": "Learn the basics of machine learning.",
  "duration": 45,
  "imageUrl": "https://player.mylearningplatform.com/image/l3ssup3rh3r0s",
  "mobileLaunchUrl": "https://player.mylearningplatform.com/mobile/launch/l3ssup3rh3r0s",
  "authorId": "507f1f77bcf86cd799439011",
  "courseId": "507f1f77bcf86cd799439011",
  "translations": [
    {
      "lang": "fr",
      "translatedFields": {
        "description": "Apprenez les bases de l'apprentissage automatique.",
        "launchUrl": "https://player.mylearningplatform.com/launch/l3ssup3rh3r0s/fr",
        "mobileLaunchUrl": "https://player.mylearningplatform.com/mobile/launch/l3ssup3rh3r0s/fr",
        "name": "Cours intensif sur l'apprentissage automatique",
        "subjects": [
          "Apprentissage automatique",
          "TI"
        ]
      }
    }
  ]
}