Skip to main content

Get question bank

The purpose of this API is to get a question bank.

Request URL:

https://learn.zoho.com/learn/api/v1/portal/<portalUrl>/question-bank
OAuth Scope:ZohoLearn.questionbank.READ
Request Method: GET
ParameterDescriptionRequired
 questionbank.urlURL of the question bank Required

Response

Copied{
   "STATUS": "OK",
   "DATA": {
       "questionCount": "0",
       "clientsCount": "0",
       "bannerType": "ZFS",
       "canEdit": "true",
       "description": "A brief description of this Question bank",
       "colorIndex": "6",
       "articleCount": "0",
       "nameTile": "Q",
       "type": "QUESTION_BANK",
       "url": "question-bank-1",
       "canManage": "true",
       "createdBy": {
           "role": "MEMBER",
           "name": "James Arthur",
           "colorIndex": "1",
           "emailId": "arthur@zylker.com",
           "id": "799705715",
           "type": "MEMBER",
           "learnerCourseStatus": "YET_TO_START",
           "status": "ACTIVE",
           "learnerCourseProgress": "0.0"
       },
       "coAuthors": [
           {
               "role": "ADMIN",
               "name": "James Arthur",
               "colorIndex": "1",
               "emailId": "arthur@zylker.com",
               "id": "799705715",
               "type": "MEMBER",
               "learnerCourseStatus": "YET_TO_START",
               "status": "ACTIVE",
               "learnerCourseProgress": "0.0"
           }
       ],
       "name": "Question bank 1",
       "createdTime": "12 Jul, 04:29 AM",
       "categories": [
           {
               "questionCount": "1",
               "selectedCount": "0",
               "itemId": "6342496000000086129",
               "itemType": "HUB",
               "name": "Topic 2",
               "questions": [],
               "id": "6342496000000085093",
               "url": "topic-2",
               "subCategories": [],
               "mark": "0",
               "status": "ACTIVE"
           },
           {
               "questionCount": "4",
               "selectedCount": "0",
               "itemId": "6342496000000086129",
               "itemType": "HUB",
               "name": "Topic 1",
               "questions": [],
               "id": "6342496000000086135",
               "url": "topic-1",
               "subCategories": [],
               "mark": "0",
               "status": "ACTIVE"
           }
       ],
       "id": "6342496000000086129",
       "logoBgColorIndex": "0",
       "createdUser": "799705715",
       "status": "ACTIVE"
   }
}

Show full

Show less

Sample URL

Copiedhttps://learn.zoho.com/learn/api/v1/portal/zylker-network/question-bank?questionbank.url=question-bank-1