Learning Paths Via API

Retrieve a list of learning paths over the API, with the request URI and XML response including ID, name, description and duration. Questions this answers: How do I get the courses in a learning path through the API? How do I get the users assigned to a learning path through the API?

Sep 26, 2026
Knowledge

Title

Last Updated

3/26/2026

URL Name

learning-paths-via-api

Product

Litmos

Body

Get Learning Paths

Get a list of learning paths in your organization.

Request URI

GET /learningpaths?

Response Body (XML)

<LearningPaths>
    <LearningPath>
        <Id></Id>
        <Name></Name>
        <Description></Description>
        <DurationMinutes>integer</DurationMinutes>
        <Active></Active>
        <OriginalId></OriginalId>
        <ForSale>true/false</ForSale>
        <Price>integer(decimal)</Price>
        <EcommerceShortDescription>string</EcommerceShortDescription>
        <EcommerceLongDescription>string</EcommerceLongDescription>
        <AccessTillDate>YYYY-MM-DDTHH:MM:SS.SSS</AccessTillDate>
        <AccessTillDays>integer</AccessTillDays>
        <IsEquivalency> true or false </IsEquivalency>
        <LearningPathTeamLibrary>false</LearningPathTeamLibrary>
    </LearningPath>
    <LearningPath>
        ...
    </LearningPath>
</LearningPaths>

NOTE:

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

Get a Learning Path

Get a specific learning path record.

Request URI

GET /learningpaths/{learningpathid}?

Response Body (XML):

<LearningPath xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <Id></Id>
    <Name></Name>
    <Description></Description>
    <DurationMinutes>integer</DurationMinutes>
    <Active></Active>
    <OriginalId></OriginalId>
    <ForSale>true/false</ForSale>
    <Price></Price>
    <EcommerceShortDescription>string</EcommerceShortDescription>
    <CommerceLongDescription>string</CommerceLongDescription>
    <AccessTillDate>datetime [iso 8601 format]</AccessTillDate>
    <IsEquivalency>true or false</IsEquivalency>
    <LearningPathTeamLibrary>false</LearningPathTeamLibrary>
</LearningPath>

NOTE:

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

Get Learning Path Courses

Get the course records that have been added into a learning path.

Request URI

GET /learningpaths/{learningpathid}/courses?

Response Body (XML)

<Courses>
    <Course>
        <Id></Id>
        <Code></Code>
        <Name></Name>
        <Description/>
        <DurationMinutes>integer</DurationMinutes>
        <Active></Active>
        <ForSale></ForSale>
        <Price></Price>
        <OriginalId></OriginalId>
        <EquivalencyId></EquivalencyId>
        <EquivalencyGroupName></EquivalencyGroupName>
    </Course>
    <Course>
        ...
    </Course>
</Courses>

NOTE:

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

Get Learning Path Users

Get a list of users assigned to a learning path.

Request URI

GET /learningpaths/{learningpathid}/users?

Response Body (XML)

<Users>
    <User>
        <Id></Id>
        <UserName></UserName>
        <FirstName></FirstName>
        <LastName></LastName>
        <Completed></Completed>
        <PercentageComplete></PercentageComplete>
    </User>
    <User>
        ...
    </User>
</Users>

Delete a learning path

Delete a learning path record

Request URI

DELETE /learningpaths/{learningpathid}?

Response Header

200 OK