Allows you to get information about a course by providing a unique identifier from your external system.
The external ID of the course to retrieve.
OK Response
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
The course's unique identifier
The course's external ID, usually a unique identifier from the calling system
The Name of the course
The description of the course
The HTML description of the course
The setting for if this course is available to be delivered in an instructor-led format
The setting for if this course is available to be delivered in a self-paced format
The Id of the owning organization for this course
The name of the owning organization for this course
The Id of the content provider for this course (if any)
The name of the content provider for this course (if any)
See Activity.
The activity's unique identifier
The Id of the activity's parent activity (if any)
The internal Id of the activity.
The Id of the activity type:
- ScormModule = 2
- Lab = 4
- Survey = 10
- InstructorSurvey = 20
- OrganizationSurvey = 30
- ExternalLink = 40
- Assessment = 50
- Video = 60
- Document = 70 - Section = 80
The activity's type name
The activity's name
The activity's description
The activity's subtitle
The activity's setting to allow retakes
The activity's setting to allow review
The activity's url
The activity's sort order index
The activity's setting for if the activity is required for course completion
The activity's availablility type id
- Everyone = 0
- Instructors Only = 1
The activity's expected duration in seconds
The activity's setting as a scored lab (This only applies to Lab type activities)
See Activity.
The course's duration.
The course's duration type identification. Values include:
- Minutes = 0
- Hours = 1
- Days = 2
- Weeks = 3
See Tag.
The tag's unique identifier.
The tag's name.
See CustomField
The name of the custom field.
The value of the custom field.
When the course was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
the course was last modified. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.