Skip to product menu
Skip to main content

Get quiz lesson

The purpose of this API is to get a quiz lesson.

Request URL:https://learn.zoho.com/learn/api/v1/portal/<networkurl>/course//lesson/
OAuth Scope:ZohoLearn.lesson.READ
Request Method:GET
ParameterDescriptionRequired
course.urlURL of the courseRequired
lesson.urlURL of the lessonRequired

Success Response

Copied{
 "STATUS": "OK",
   "DATA": {
       "questionCount": "0",
       "modifiedTime": "1689228046969",
       "canEdit": "true",
       "courseUrl": "course-1",
       "type": "VIDEO",
       "canFavourite": "true",
       "createdTime": "1689155682441",
       "modifiedBy": "799705715",
       "id": "6342496000000086065",
       "viewCount": "5",
       "courseId": "6342496000000086001",
       "createdUser": {
           "role": "MEMBER",
           "name": "James Arthur",
           "colorIndex": "1",
           "emailId": "arthur@zylker.com",
           "id": "799705715",
           "type": "MEMBER",
           "learnerCourseStatus": "YET_TO_START",
           "status": "ACTIVE",
           "learnerCourseProgress": "0.0"
       },
       "order": "4",
       "canDuplicate": "true",
       "elapsedLongTime": "0",
       "url": "video-lesson-embed-url",
       "courseName": "Course 1",
       "currentQuestionNumber": "0",
       "lessonVersion": "1.5",
       "learnerStatus": "0.0",
       "createdBy": "799705715",
       "lessonMeta": {
          "preventSeek": "false",
           "showDiscussion": "true",
           "blocks": "[{\"blockId\":0,\"layout\":\"lms-lesson-video\",\"isEmbed\":true,\"background\":\"\",\"columns\":\"1\",\"items\":[{\"VIDEO_TYPE\":\"YOUTUBE\",\"posterUrl\":\"https:\\/\\/i.ytimg.com\\/vi\\/7DQK0BB15EQ\\/hqdefault.jpg\",\"VIDEO_ID\":\"7DQK0BB15EQ\",\"placeholder\":{},\"embedHtml\":\"<iframe width=\\\"1280\\\" height=\\\"720\\\" src=\\\"https:\\/\\/www.youtube.com\\/embed\\/7DQK0BB15EQ?feature=oembed\\\" frameborder=\\\"0\\\" allow=\\\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\\\" allowfullscreen title=\\\"Zoho Learn | All-in-one knowledge management and training software\\\"><\\/iframe>\",\"type\":\"centered\",\"url\":\"https:\\/\\/www.youtube.com\\/watch?v=7DQK0BB15EQ\"}]}]",
           "showDownload": "false",
           "EDIT_ZFS_ID": "5145876000000113001",
           "lastupdatedid": "0",
           "blockordermap": "{\"0\":0}",
           "VIEW_ZFS_ID": "5145876000000113001",
           "content": ""
       },
       "name": "Video Lesson Embed URL",
       "status": "ACTIVE",
       "lessons": []
   }
}

Show full

Show less

Failure Response: Trying to view drip lessons

Copied{
 "result":"failure",
   "reason": "This content will be available to you later.",
    "errorCode": "112"
}

Failure Response: Trying to view a lesson without satisfying the previous lesson completion criteria

Copied{
 "result":"failure",
   "reason": "This content will be available only after you complete previous lessons.",
    "errorCode": "113"
}

Failure Response: Access Denied

Copied{
    "result": "failure",
    "reason": "Access Denied",
    "errorCode": "9001"
}

Sample URL:

Copiedhttps://learn.zoho.com/learn/api/v1/portal/zylker-network/course//lesson/?course.url=course-1&lesson.url=video-lesson-embed-url