Get Curriculum with Section and Material
Returns a curriculum's full content tree: sections with their materials and exercises, plus assignments and quizzes, in display order. Use it to read or copy a course's structure.
GET
/tutor/curriculum/{course_id}Get Curriculum with Section and Material
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/tutor/curriculum/{course_id}' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"course_curriculum": {
"course_id": "2083",
"sequential_viewing": 0,
"published_count": 0,
"total_time": 0,
"resources": [
{
"section_id": 6174,
"section_name": "Introduction Update name",
"description": "Course Introudction update",
"status": "published",
"in_curriculum": 1,
"display_index": 25314,
"course_id": 2083,
"resource_type": 1,
"is_prerequisite": 1,
"resources": [
{
"material_id": 17489,
"file_name": "External link",
"material_name": "External URL Teaching Material",
"description": "<p>Teaching Material Description</p>",
"material_source": "external_url",
"external_url": "https://www.youtube.com/watch?v=UWMzKXsY9A4",
"type": "youtube",
"is_active": 1,
"display_index": 25317,
"view_count": null,
"is_downloadable": 0,
"is_drm": 0,
"drm_url": "",
"resource_type": 4,
"external_video_play": 0,
"vimeo_transcoding_status": null,
"freepreview": null,
"vimeo_url": 0,
"is_prerequisite": 1,
"parent_id": 6174,
"duration_seconds": 0,
"created_at_timestamp": 1743139293,
"is_enterprise_drm": 0,
"vdocipher_video_id": null,
"vdocipher_transcoding_status": 1,
"is_videocrypt_drm": 0,
"videocrypt_video_id": null,
"videocrypt_transcoding_status": 1,
"scorm_cloud_id": null,
"scorm_import_job_id": null,
"scorm_course_id": null,
"scorm_transcoding_status": null,
"scorm_error_msg": null,
"is_scorm": 0,
"scorm_version": null,
"scorm_entry_point": null,
"file_size": null
},
{
"material_id": 17491,
"file_name": "big_buck_bunny_720p_1mb+(1).mp4",
"material_name": "Vimeo+Video+Upload",
"description": "<p>Vimeo+Video+upload</p>",
"material_source": "file",
"external_url": null,
"type": "video/mp4",
"is_active": 1,
"display_index": 25319,
"view_count": null,
"is_downloadable": 1,
"is_drm": 0,
"drm_url": "0",
"resource_type": 4,
"external_video_play": 0,
"vimeo_transcoding_status": null,
"freepreview": null,
"vimeo_url": 1070226703,
"is_prerequisite": 0,
"parent_id": 6174,
"duration_seconds": 0,
"created_at_timestamp": 1743142868,
"is_enterprise_drm": 0,
"vdocipher_video_id": null,
"vdocipher_transcoding_status": 1,
"is_videocrypt_drm": 0,
"videocrypt_video_id": null,
"videocrypt_transcoding_status": 1,
"scorm_cloud_id": null,
"scorm_import_job_id": null,
"scorm_course_id": null,
"scorm_transcoding_status": null,
"scorm_error_msg": null,
"is_scorm": 0,
"scorm_version": null,
"scorm_entry_point": null,
"file_size": null
},
{
"material_id": 17493,
"file_name": "",
"material_name": "Text Html Material",
"description": "<p>Text Html Description And Instructions</p>",
"material_source": "html_text",
"external_url": null,
"type": "",
"is_active": 1,
"display_index": 25321,
"view_count": null,
"is_downloadable": 0,
"is_drm": 0,
"drm_url": "",
"resource_type": 4,
"external_video_play": 0,
"vimeo_transcoding_status": null,
"freepreview": null,
"vimeo_url": 0,
"is_prerequisite": 0,
"parent_id": 6174,
"duration_seconds": 0,
"created_at_timestamp": 1743143165,
"is_enterprise_drm": 0,
"vdocipher_video_id": null,
"vdocipher_transcoding_status": 1,
"is_videocrypt_drm": 0,
"videocrypt_video_id": null,
"videocrypt_transcoding_status": 1,
"scorm_cloud_id": null,
"scorm_import_job_id": null,
"scorm_course_id": null,
"scorm_transcoding_status": null,
"scorm_error_msg": null,
"is_scorm": 0,
"scorm_version": null,
"scorm_entry_point": null,
"file_size": null
},
{
"exercise_id": 1026,
"exercise_name": "Online Exercise",
"test_time": 1800,
"attempts": 2,
"instructions": null,
"section_id": 6174,
"question_list_id": null,
"num_of_questions": 0,
"display_index": 25323,
"times_taken": 0,
"passed": null,
"perfect": null,
"status": "published",
"activate_at": 0,
"deactivate_at": 0,
"availability": 1,
"resource_type": 5,
"results_declared": 1,
"exam_type": 1,
"freepreview": null,
"is_prerequisite": 1,
"is_assignment": 0,
"created_at_timestamp": 1743143548
}
],
"duration_seconds": 0
}
]
}
}Access: Institute admins, tutors of the curriculum, plus custom roles that can view curriculum. Learners and parents enrolled in it can also call it and see only items published to their class.
Path parameters
The curriculum ID, as the last URL segment.
Query parameters
class_idinteger
A batch class using this curriculum. Learners see only the items visible in that class.
only_previewinteger
1 returns only items marked as free preview.Response
codeinteger
Example:
200messagestring
Example:
Successcourse_curriculumobject
Show child attributesHide child attributes
Example:
0course_curriculum.resourcesobject[]
Show child attributesHide child attributes
Example:
6174Example:
Introduction Update nameExample:
Course Introudction updateExample:
publishedExample:
1Example:
25314Example:
1Show child attributesHide child attributes
Example:
17489Example:
External linkExample:
External URL Teaching MaterialExample:
<p>Teaching Material Description</p>Example:
external_urlExample:
https://www.youtube.com/watch?v=UWMzKXsY9A4Example:
youtubeExample:
1Example:
25317Example:
0Example:
0Example:
0Example:
0Example:
1Example:
6174Example:
0Example:
1743139293Example:
0Example:
1Example:
0Example:
1Example:
0Example:
0Notes: A curriculum from another institute returns "Invalid course id"; one you are not linked to returns "Invalid Course Id". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.