• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Documentation

APIs

Home › Litmos Documentation › Courses Via API

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>
    </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

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>
    <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>
</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>
    </Module>
</Modules>

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

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Match keywords.

Useful Links

  • Release Notes
  • Customer Portal

In this article

Related articles

  1. Users Via API
  2. Instructor Led Training Via API
  3. Date Range Delta Queries Via API

Also of Interest

  • Top eLearning Software
  • Continuous Learning in the Workplace
  • Free eLearning Platform
  • Corporate LMS
  • Enterprise Learning Management System
  • LMS Platform
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Compliance Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
UK: +44 20 4551 1606
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms