Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Courses

List all courses

🔑

Required OAuth scope: courses:read.

📖

This endpoint is paginated with a page size of 500 courses. For more information, see the Pagination guide.

Lists all courses in your platform.

get/api/v2/courses

Query parameters

ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on createdAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}
ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on modifiedAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}
eq'archived' | 'deleted' | 'published'

Filter on values equal to the given one

Filter on status property with LHS bracket notation.

Expected value format is a string (archived, deleted, published).

{
  "eq": "archived"
}
eq'elearning standard' | 'external' | 'native'

Filter on values equal to the given one

Filter on type property with LHS bracket notation.

Expected value format is a string (elearning standard, external, native).

{
  "eq": "elearning standard"
}
eqstring ObjectId

Filter on values equal to the given one

Filter on authorId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011"
}
eqstring ObjectId

Filter on values equal to the given one

Filter on groupId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011"
}
eqstring ObjectId

Filter on values equal to the given one

Filter on originalAuthorId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011"
}
instring[]

Filter on values including the given ones

Filter on tagIds property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "in": [
    "507f1f77bcf86cd799439011"
  ]
}
instring[]

Filter on values including the given ones

Filter on coAuthorIds property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "in": [
    "507f1f77bcf86cd799439011"
  ]
}
eq'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'

Filter on values equal to the given one

instring[]

Filter on values including the given ones

Filter on sourceLang property with LHS bracket notation.

Expected value format is a string (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).

{
  "eq": "bg",
  "in": [
    "bg"
  ]
}
eqboolean

Filter on values equal to the given one

Filter on collaborativeLearning property with LHS bracket notation.

Expected value format is a boolean (true or false).

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 500 courses.

namestring required

The title of the course.

sourceLang'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 in which the course is created.

authorIdstring ObjectId required

The unique ID of the author of the course.

groupIdstring ObjectId required

The unique ID of the group where the course was created.

coAuthorIdsstring[] required

The list of unique IDs of the co-authors of the course.

descriptionstring

The description of the course.

durationnumber

An estimate of the time required to complete the course. The expected value is a number of minutes.

_idstring ObjectId required

The unique ID of the course.

createdAtstring date-time required

The date and time when the course was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

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 in which the course is displayed when the learner’s profile language is not available.

modifiedAtstring date-time required

The date and time when the course was last updated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)). Note that when translations are updated or when the course is archived/restored, its modification date does not change.

status'archived' | 'deleted' | 'published' required

The status of the course.

type'elearning standard' | 'external' | 'native' required

The type of the course.

externalPlatformstring

The external platform where the course comes from. It is only set if the course has the external type.

currentVersionNumberinteger

The current version of the course (most recent release).

collaborativeLearningboolean

A boolean indicating whether collaborative learning is enabled or not.

Example response

[
  {
    "name": "Employee Onboarding",
    "authorId": "507f1f77bcf86cd799439011",
    "groupId": "507f1f77bcf86cd799439011",
    "coAuthorIds": [
      "507f1f77bcf86cd799439011"
    ],
    "description": "This course will teach you how to onboard a new employee!",
    "_id": "507f1f77bcf86cd799439011",
    "translations": [
      {
        "lang": "fr",
        "translatorIds": [
          "507f1f77bcf86cd799439011"
        ],
        "translatedFields": {
          "name": "Accueil des employés",
          "description": "Ce module vous apprend à intégrer un nouveau collaborateur !"
        }
      }
    ],
    "externalPlatform": "Udemy"
  }
]