GET /api/v1/courses
Return the list of all courses in the platform, as an array.
Fields
-
_id
(string): Unique identifier of the course. -
author
(string): Email address of the course’s main author. -
creationDate
(string): Date and time of the course creation, in ISO 8601 format. -
defaultLang
(string): Default language for the course. -
description
(string): Contents of the fieldDescription
in the course. -
[Deprecated]
lang
(string): Source language for the course. -
modificationDate
(string): Date and time of the last modification of the course, in ISO 8601 format. -
name
(string): Title of the course. -
externalPlatform
(string): Optional. Name of the external platform if the course is attached to an external content provider. -
sourceLang
(string): Source language for the course. -
status
(string): Status of the course. Possible values arepublished
orarchived
. -
type
(string): Source where the course was created. Possible values are:internal
: Courses created on the 360Learning platformexternal
: Courses from external content providersscorm
: Courses uploaded on the 360Learning platform from a SCORM file
-
coAuthors
(array of strings): List of email addresses of co-authors of the course. -
courseDuration
(integer): Duration of the course (in minutes). -
group
(string): Unique identifier of the course’s owner group. -
groupName
(string): Name of the course’s owner group. -
reactionScore
(integer): Reaction Score of the course. -
relevanceScore
(integer): Relevance Score of the course. -
translationLangs
(array): List of languages added to the course, with the following fields:lang
(string): Bigram of the language.published
(boolean):true
if the language is available in playing mode for the course.false
otherwise.translators
(array of strings): List of the email addresses of the translators.
Parameters (optional)
You can add the following optional parameters to the query:
createdAfter
: return courses that have been created after the specified date, compared to the value of the fieldcreationDate
. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.createdBefore
: return courses that have been created before the specified date, compared to the value of the fieldcreationDate
. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.modifiedAfter
: return courses that have been edited after the specified date, compared to the value of the fieldmodificationDate
. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.modifiedBefore
: return courses that have been edited before the specified date, compared to the value of the fieldmodificationDate
. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.
Changelog :
- Milestone C (March 22) The courses now also include the groupId and the groupName
- Milestone V (Oct 21)
- The draft state does not exist anymore
- The optional
publishedAt
field is not returned anymore
- Milestone K (Mar 21): added coAuthors and translationLangs
- Milestone Q (Nov 19): added creationDate and modificationDate
- Milestone O (Sept 19): added "skills"
- Milestone H (Nov 18): description is now available.
- June 15th, 2022: added
reactionScore
andrelevanceScore
, and detailed each returned field. - Oct 19th, 2022: added
courseDuration
- Nov 9th, 2022:
- Added
sourceLang
anddefaultLang
- Added Fields section about date filters
- Added
Servers
- https://app.360learning.com
Query parameters
Name | Type | Required | Description |
---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.