Courses Via API

Retrieve a list of courses in your organisation over the API, with the request URI and response fields including ID, code, name and active status. Questions this answers: How do I get course details through the Litmos API? Can I get a list of all courses and their descriptions via the API?

Sep 26, 2026
Knowledge

Title

Courses Via API

Article Number

000004589

URL Name

courses-via-api

Get a List of Courses

Get a list of Courses in your organization.

Request URI

GET /courses?

Response Body

<Courses>
    <Course>
        <Id>string [max length 50]</Id>
        <Code>string [max length 50]</Code>
        <Name>string [max length 255]</Name>
        <Active>true/false</Active>
        <ForSale>true/false</ForSale>
        <OriginalId>integer</OriginalId>
        <Description>string</Description>
        <EcommerceShortDescription>string</EcommerceShortDescription>
        <EcommerceLongDescription>string</EcommerceLongDescription>
        <CourseCodeForBulkImport>string [max length 255]</CourseCodeForBulkImport>
        <Price>integer</Price>
        <AccessTillDate>integer</AccessTillDate>
        <CourseTeamLibrary>true/false</CourseTeamLibrary>
        <DurationMinutes>integer</DurationMinutes>
    </Course>
    <Course>
        ...
    </Course>
</Courses>

Note:

OriginalId can be used as part of a single sign in process to take a user straight into a particular course.
ForSale indicates if the course has been marked for sale via the Litmos UI
DurationMinutes has to be shown in minutes. For example: 1 hour and 30 minutes will be shown as 90 minutes.

Get a Course

Get a single Course record.

Request URI

GET /courses/{courseid}?

Response Body

<Course xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <Id>string [max length 50]</Id>
    <Code>string [max length 50]</Code>
    <Name>string [max length 255]</Name>
    <Active></Active>
    <ForSale>true/false</ForSale>
    <OriginalId></OriginalId>
    <Description></Description>
    <EcommerceShortDescription>string</EcommerceShortDescription>
    <CommerceLongDescription>string</CommerceLongDescription>
    <CourseCodeForBulkImport></CourseCodeForBulkImport>
    <Price></Price>
    <AccessTillDate>datetime [iso 8601 format]</AccessTillDate>
    <CourseTeamLibrary>true/false</CourseTeamLibrary>
    <DurationMinutes>integer</DurationMinutes>
    <Tags></Tags>
</Course>

Get Course Details

Get all the details of a Course including arrays of data associated to the Course .

Request URI

GET /courses/{courseid}/details?

Response Body (XML)

<Course>
    <Id>string [max length 50]</Id>
    <OriginalId>integer</OriginalId>
    <Code>string [max length 50]</Code>
    <Name>string [max length 255]</Name>
    <Description>string</Description>
    <CourseCodeForBulkImport>string [max length 50]</CourseCodeForBulkImport>
    <Active>true/false</Active>
    <IncludeInLibrary>true/false</IncludeInLibrary>
    <CompleteInOrder>true/false</CompleteInOrder>
    <CourseImageURL i_nil="true"/>
    <CreatedDate>YYYY-MM-DDTHH:MM:SS.SS</CreatedDate>
    <UpdatedDate>YYYY-MM-DDTHH:MM:SS.SS</UpdatedDate>
    <CreatedBy>string [max length 50]</CreatedBy>
    <UpdatedBy>string [max length 50]</UpdatedBy>
    <ForSale>true/false</ForSale>
    <EcommerceShortDescription/>
    <EcommerceLongDescription/>
    <Price>0.00</Price>
    <AccessTillDate i_nil="true"/>
    <AccessTillDays i_nil="true"/>
    <DueDate>YYYY-MM-DDTHH:MM:SS.SS</DueDate>
    <DueDateSpan>integer</DueDateSpan>
    <ComplianceDate i_nil="true"/>
    <ComplianceDateSpan i_nil="true"/>
    <ComplianceRetake i_nil="true"/>
    <Languages xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>Cultureid</a:string>
        <a:string>Cultureid</a:string>
    </Languages>
    <Topics>
        <a:string>string [max length 200]</a:string>
        <a:string>string [max length 200]</a:string>
    </Topics>
    <Tags xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 30]</a:string>
        <a:string>string [max length 30]</a:string>
    </Tags>
    <CoursePreRequisites xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 50]</a:string>
    </CoursePreRequisites>
    <LearningPathPreRequisites xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 50]</a:string>
    </LearningPathPreRequisites>
    <Skills xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 100]</a:string>
    </Skills>
    <Social>true/false</Social>
    <DiscussionForum>true/false</DiscussionForum>
    <AdvCourseCustomField1/>
    <AdvCourseCustomField2/>
    <AdvCourseCustomField3/>
    <AdvCourseCustomField4/>
    <AdvCourseCustomField5/>
    <AdvCourseCustomField6/>
    <AdvCourseCustomField7/>
    <AdvCourseCustomField8/>
    <AdvCourseCustomField9/>
    <AdvCourseCustomField10/>
    <AllModulesNewWindow>true/false</AllModulesNewWindow>
    <Certificate>true/false</Certificate>
    <BoostsReleased>integer</BoostsReleased>
    <BoostFrequency>integer</BoostFrequency>
    <DurationMinutes>integer</DurationMinutes>
</Course>

NOTE:

DurationMinutes has to be shown in minutes. For example: 1 hour and 30 minutes will be shown as 90 minutes.

Get Course Details with Expired Course Images

Get all the details of a Course with a Course image expired on a given UTC Date and Time.

Request URI

GET /courses/{courseid}/details?courseimageexpiration={YYYY-MM-DD HH:MM:SS}

Response Body (XML)

<Course>
    <Id>string [max length 50]</Id>
    <OriginalId>integer</OriginalId>
    <Code>string [max length 50]</Code>
    <Name>string [max length 255]</Name>
    <Description>string</Description>
    <CourseCodeForBulkImport>string [max length 50]</CourseCodeForBulkImport>
    <Active>true/false</Active>
    <IncludeInLibrary>true/false</IncludeInLibrary>
    <CompleteInOrder>true/false</CompleteInOrder>
    <CourseImageURL>URL</CourseImageURL>
    <CreatedDate>YYYY-MM-DDTHH:MM:SS.SS</CreatedDate>
    <UpdatedDate>YYYY-MM-DDTHH:MM:SS.SS</UpdatedDate>
    <CreatedBy>string [max length 50]</CreatedBy>
    <UpdatedBy>string [max length 50]</UpdatedBy>
    <ForSale>true/false</ForSale>
    <EcommerceShortDescription/>
    <EcommerceLongDescription/>
    <Price>0.00</Price>
    <AccessTillDate i_nil="true"/>
    <AccessTillDays i_nil="true"/>
    <DueDate>YYYY-MM-DDTHH:MM:SS.SS</DueDate>
    <DueDateSpan>integer</DueDateSpan>
    <ComplianceDate i_nil="true"/>
    <ComplianceDateSpan i_nil="true"/>
    <ComplianceRetake i_nil="true"/>
    <Languages xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>Cultureid</a:string>
        <a:string>Cultureid</a:string>
    </Languages>
    <Topics>
        <a:string>string [max length 200]</a:string>
        <a:string>string [max length 200]</a:string>
    </Topics>
    <Tags xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 30]</a:string>
        <a:string>string [max length 30]</a:string>
    </Tags>
    <CoursePreRequisites xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 50]</a:string>
    </CoursePreRequisites>
    <LearningPathPreRequisites xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 50]</a:string>
    </LearningPathPreRequisites>
    <Skills xmlns_a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">;
        <a:string>string [max length 100]</a:string>
    </Skills>
    <Social>true/false</Social>
    <DiscussionForum>true/false</DiscussionForum>
    <AdvCourseCustomField1/>
    <AdvCourseCustomField2/>
    <AdvCourseCustomField3/>
    <AdvCourseCustomField4/>
    <AdvCourseCustomField5/>
    <AdvCourseCustomField6/>
    <AdvCourseCustomField7/>
    <AdvCourseCustomField8/>
    <AdvCourseCustomField9/>
    <AdvCourseCustomField10/>
    <AllModulesNewWindow>true/false</AllModulesNewWindow>
    <Certificate>true/false</Certificate>
    <BoostsReleased>integer</BoostsReleased>
    <BoostFrequency>integer</BoostFrequency>
</Course>

Get Modules in a Course

Get a list of all Modules in a Course.

Request URI

GET /courses/{courseid}/modules?

Response Body (XML)

<Modules>
    <Module>
        <Id>string [max length 50]</Id>
        <Code>string [max length 20]</Code>
        <Name>string [max length 255]</Name>
        <Description>string [optional, max length 2000]</Description>
        <ModuleType>integer</ModuleType>
        <Active>true/false</Active>
        <HideDescription>true/false</HideDescription>
        <NewWindow>true/false</NewWindow>
        <ReviewMode>true/false</ReviewMode>
        <ContentURL>string [optional, max length 2000]</ContentURL>
        <DurationMinutes>integer</DurationMinutes>
     </Module>
</Modules>

NOTE:

DurationMinutes has to be shown in minutes. For example: 1 hour and 30 minutes will be shown as 90 minutes.

Get Users Assigned to a Course

Get a list of all users assigned to a Course.

Request URI

GET /courses/{courseid}/users?

Response Body

<Users>
    <User>
        <Id>string [max length 50]</Id>
        <UserName>string [max length 255]</UserName>
        <FirstName>string [max length 100]</FirstName>
        <LastName>string [max length 100]</LastName>
        <Completed>true/false</Completed>
        <PercentageComplete>integer (decimal)</PercentageComplete>
        <CompliantTill>2025-01-01T04:37:06.23 [ISO8601]</CompliantTill>
        <DueDate>2021-12-31T04:37:06.23 [ISO8601]</DueDate>
        <AccessTillDate></AccessTillDate>
    </User>
    <User>
        ...
    </User>
</Users>

Get all User Results for a Course

Get all results of users assigned to a Course.

Request URI

GET /courses/{courseid}/users?

Response (XML)

<Users xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <User>
        <Id>string [max length 50]</Id>
        <UserName>string [max length 255]</UserName>
        <FirstName>string [max length 100]</FirstName>
        <LastName>string [max length 100]</LastName>
        <Completed>true/false</Completed>
        <PercentageComplete>decimal</PercentageComplete>
        <CompliantTill i_nil="true"/>
        <DueDate i_nil="true"/>
        <AccessTillDate i_nil="true"/>
    </User>
    <User>
        .....
    </User>
</Users>

Delete a Course

Delete a Course record.

Request URI

DELETE /courses/{courseid}?

Response Header

200 OK

Resolution

Owner

Jason van Ravenswaay

Validation Status

Not Validated

Publication Status

Published

Article Total View Count

Created By

Jason van Ravenswaay, 10/8/2026, 5:37 AM

Assigned By

Created Date

10/8/2026, 5:37 AM

Assigned To

First Published Date

9/26/2026, 6:02 AM

Last Published Date

9/26/2026, 6:02 AM

Last Modified By

Jason van Ravenswaay, 10/8/2026, 5:37 AM

Last Modified Date

10/8/2026, 5:37 AM

Archived Date

Courses Via API

Get a List of Courses

Request URI

Response Body

Get a Course

Request URI

Response Body

Get Course Details

Request URI

Response Body (XML)

Get Course Details with Expired Course Images

Request URI

Response Body (XML)

Get Modules in a Course

Request URI

Response Body (XML)

Get Users Assigned to a Course

Request URI

Response Body

Get all User Results for a Course

Request URI

Response (XML)

Delete a Course

Request URI

Response Header

Files(0)

Need Answers Fast?

Courses Via API

Article Information

Content

Get a List of Courses

Request URI

Response Body

Get a Course

Request URI

Response Body

Get Course Details

Request URI

Response Body (XML)

Get Course Details with Expired Course Images

Request URI

Response Body (XML)

Get Modules in a Course

Request URI

Response Body (XML)

Get Users Assigned to a Course

Request URI

Response Body

Get all User Results for a Course

Request URI

Response (XML)

Delete a Course

Request URI

Response Header

Information

Visibility

Administration

Archive Information

Trending Articles

Need Answers Fast?