Request: GET \course/{id}/modules

Note:

With this method, you can retrieve a list of modules (both content and trainings) belonging to a single course.

Permissions to Run the Request

The Account Owner, Account Administrators, Department Administrators, users with custom roles, or Course Author with the 'Can edit' access to the content item.

Request Headers

Header	Description
Authorization (required)	Access token. You can obtain a token by making a request.

Existing customers may continue using ispringlearn.com, and new customers should use ispring.com.

Response Parameters

Parameters	Description
modules	An array containing a list of course modules
module	An array containing information about a course module
moduleId	The course module ID
itemId	The ID of the content item or a training belonging to the course. This parameter indicates the ID of a content item or a training assigned to it in the account, outside the course, and doesn't coincide with the module Id parameter
courseId	The ID of the course to which the module belongs
title	The name of the course module
description	The description of the course module
authorId	The ID of the content item’s author (appears in the response only if the type parameter = material)
addedDate	The creation date of a content item or a training included in a course
viewUrl	The link to view a course content (appears in the response only if the type parameter = material)
type	The course module type. The possible values are: material training
sequentialNumber	Sequential number of the module in the course

Response Codes

Code	Text	Description
200	OK	The request has been successfully processed
404	Unknown content item	The course with the indicated ID is not found
403	Permission denied	The user doesn't have enough permissions to run the request or can't edit the content item.

Sample Request

GET /course/a849d840-6a8a-11ef-b992-36bad3a603e7/modules HTTP/1.1
Host: api-learn.ispringlearn.com
Accept: application/json
Authorization: gsTy154jePghm1yDv4scE9gKzqrjI8MXCXr4Yg4kz5A

XML

Sample Response

{

    "modules": [
        {
            "moduleId": "ec712528-6a8a-11ef-8749-be6337f13907",
            "itemId": "ec5e8328-6a8a-11ef-9bd7-36bad3a603e7",
            "courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7",
            "title": "Onboarding",
            "description": "Course for those who have recently joined the company",
            "authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2",
            "addedDate": "2024-09-04T06:57:17+00:00",
            "type": "material",
            "viewUrl": "courses.ispringlearn.com/view/35050-KHrJL-8FRvR-hmBHP",
            "sequentialNumber": 1
        },
        {
            "moduleId": "0e028092-6a9a-11ef-b60f-c298d4afc52f",
            "itemId": "0dd3d554-6a9a-11ef-b4ad-723c165888c7",
            "courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7",
            "title": "Quiz",
            "description": "Quiz for sales managers",
            "authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2",
            "addedDate": "2024-09-04T08:45:36+00:00",
            "type": "material",
            "viewUrl": "https://courses.ispringlearn.com/view/35050-AcGpe-PFf7E-eBzuw",
            "sequentialNumber": 2
        }
    ]
}

XML