Get All Published Courses
Returns the published course catalogue of an institute, grouped by organization, with prices, ratings, tutors and tags. Use it to show your course list on your own website or app.
GET
/institute/{institutionId}/coursesGet All Published Courses
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/institute/{institutionId}/courses?get_tutors=1&get_tags=1&get_student_count=1&tag_categories_name_array=%5B%7B%22Course%20Division%22%3A%5B%22Course%22%5D%7D%5D&order_by=ASC&page=1&per_page=<per_page>&categories_ids=239'{
"code": 200,
"message": "Success",
"tags": [
{
"tag_categories_id": 5,
"tag_categories_name": "Multiselect1",
"tag_categories_type": 1,
"status": 0,
"tag_categories_values": [
{
"tag_categories_value_id": 5,
"tag_categories_value": "option1",
"display_index": 1,
"status": 1
},
{
"tag_categories_value_id": 11,
"tag_categories_value": "value 2",
"display_index": 2,
"status": 1
}
]
},
{
"tag_categories_id": 6,
"tag_categories_name": "Boolean1",
"tag_categories_type": 2,
"status": 1
},
{
"tag_categories_id": 7,
"tag_categories_name": "Date1",
"tag_categories_type": 3,
"status": 1
},
{
"tag_categories_id": 8,
"tag_categories_name": "Text1",
"tag_categories_type": 4,
"status": 1
},
{
"tag_categories_id": 12,
"tag_categories_name": "Date2",
"tag_categories_type": 3,
"status": 1
},
{
"tag_categories_id": 13,
"tag_categories_name": "CustomF1",
"tag_categories_type": 1,
"status": 0,
"tag_categories_values": [
{
"tag_categories_value_id": 13,
"tag_categories_value": "O2",
"display_index": 2,
"status": 1
},
{
"tag_categories_value_id": 14,
"tag_categories_value": "O3",
"display_index": 3,
"status": 1
}
]
},
{
"tag_categories_id": 14,
"tag_categories_name": "Custom2",
"tag_categories_type": 1,
"status": 1,
"tag_categories_values": [
{
"tag_categories_value_id": 15,
"tag_categories_value": "1",
"display_index": 1,
"status": 1
}
]
},
{
"tag_categories_id": 15,
"tag_categories_name": "Age 6-7",
"tag_categories_type": 1,
"status": 1,
"tag_categories_values": [
{
"tag_categories_value_id": 16,
"tag_categories_value": "Age 6",
"display_index": 1,
"status": 1
},
{
"tag_categories_value_id": 17,
"tag_categories_value": "Age 7",
"display_index": 2,
"status": 1
},
{
"tag_categories_value_id": 18,
"tag_categories_value": "Age 8",
"display_index": 3,
"status": 1
},
{
"tag_categories_value_id": 19,
"tag_categories_value": "Age 9",
"display_index": 4,
"status": 1
}
]
},
{
"tag_categories_id": 16,
"tag_categories_name": "OMOTEC",
"tag_categories_type": 2,
"status": 1
},
{
"tag_categories_id": 23,
"tag_categories_name": "Age 9-12",
"tag_categories_type": 1,
"status": 1,
"tag_categories_values": [
{
"tag_categories_value_id": 28,
"tag_categories_value": "Age 9",
"display_index": 1,
"status": 1
},
{
"tag_categories_value_id": 29,
"tag_categories_value": "Age 10",
"display_index": 2,
"status": 1
},
{
"tag_categories_value_id": 30,
"tag_categories_value": "Age 11",
"display_index": 3,
"status": 1
},
{
"tag_categories_value_id": 31,
"tag_categories_value": "Age 12",
"display_index": 4,
"status": 1
}
]
},
{
"tag_categories_id": 24,
"tag_categories_name": "Age 3-6",
"tag_categories_type": 1,
"status": 1,
"tag_categories_values": [
{
"tag_categories_value_id": 33,
"tag_categories_value": "Age 4",
"display_index": 1,
"status": 1
},
{
"tag_categories_value_id": 32,
"tag_categories_value": "Age 3",
"display_index": 2,
"status": 1
},
{
"tag_categories_value_id": 34,
"tag_categories_value": "Age 5",
"display_index": 3,
"status": 1
},
{
"tag_categories_value_id": 35,
"tag_categories_value": "Age 6",
"display_index": 4,
"status": 1
}
]
},
{
"tag_categories_id": 25,
"tag_categories_name": "Text",
"tag_categories_type": 4,
"status": 1
}
],
"tutors": [
{
"tutor_id": 1,
"tutor_name": " Gaurav Kapoor",
"img_url": "https://d15g8b7hr8be7w.cloudfront.net/User(1)/108026-Screenshot_from_2022-04-28_14-39-00.png"
},
{
"tutor_id": 15,
"tutor_name": "Saurav Shandilya1",
"img_url": ""
},
{
"tutor_id": 21,
"tutor_name": "Ananya Sandilya",
"img_url": "https://d3j00dvqloea7o.cloudfront.net/User(21)/107513-Screenshot_from_2021-09-21_10-38-41.png"
},
{
"tutor_id": 27,
"tutor_name": "School Demo",
"img_url": ""
},
{
"tutor_id": 62,
"tutor_name": "Sanjay",
"img_url": ""
},
{
"tutor_id": 1687,
"tutor_name": "HarshitNew1",
"img_url": ""
},
{
"tutor_id": 3179,
"tutor_name": "Vaibhav Sharma",
"img_url": ""
},
{
"tutor_id": 4412,
"tutor_name": "Teacher Teacbdeiugfr",
"img_url": ""
},
{
"tutor_id": 4658,
"tutor_name": "My Teacher tEACHER",
"img_url": ""
},
{
"tutor_id": 4673,
"tutor_name": "Aa Bd",
"img_url": ""
},
{
"tutor_id": 4680,
"tutor_name": "uu PP",
"img_url": ""
},
{
"tutor_id": 4748,
"tutor_name": "Vaibhav Sharma",
"img_url": ""
},
{
"tutor_id": 4756,
"tutor_name": "AAA ZZZ",
"img_url": ""
},
{
"tutor_id": 4758,
"tutor_name": "XXX CCC",
"img_url": ""
},
{
"tutor_id": 4759,
"tutor_name": "RRRR TTT",
"img_url": ""
}
],
"institute_courses": [
{
"course_bundles": [
{
"bundle_id": 5,
"bundle_name": "IIT-JAM Maths",
"course_ids": [
"6"
],
"bundle_description": "helllllllllllllllllllllllllll",
"exam_ids": [
"1",
"7",
"52"
],
"is_test_series": 0,
"cost": 1000,
"currency_cost": 1000,
"actual_cost": 0,
"currency_actual_cost": 0,
"striked_cost": 0,
"currency_striked_cost": 0,
"position": 1,
"academic_year": 2,
"institution_bundle_id": 6,
"is_online_package": 1,
"student_count": 128,
"fees_template_ids": "8,40,41,42",
"online_registration_allowed": 1,
"free_preview_allowed": 1,
"course_type": 1,
"pretty_name": "IIT-JAMMaths",
"course_start_date": 1604620800,
"course_end_date": 1604707200,
"img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(5)/102647-SMPayment.jpg",
"stream_id": 1,
"currency_symbol": "$",
"package_cost_set": 1,
"apple_product_id": "2_5",
"rating": 0,
"num_of_rating": 0,
"tutors": [
{
"tutor_id": 1,
"tutor_name": " Gaurav Kapoor"
}
],
"tags": []
},
{
"bundle_id": 88,
"bundle_name": "Class-8",
"course_ids": [],
"bundle_description": "",
"exam_ids": [
"1"
],
"is_test_series": 1,
"cost": 55,
"currency_cost": 55,
"actual_cost": 0,
"currency_actual_cost": 0,
"striked_cost": 0,
"currency_striked_cost": 0,
"position": 1,
"academic_year": 3,
"institution_bundle_id": 92,
"is_online_package": 1,
"student_count": 19,
"fees_template_ids": "8",
"online_registration_allowed": 1,
"free_preview_allowed": 0,
"course_type": 3,
"pretty_name": "Class-8",
"course_start_date": 0,
"course_end_date": 0,
"img_url": "",
"stream_id": 1,
"currency_symbol": "$",
"package_cost_set": 1,
"apple_product_id": "2_88",
"rating": 0,
"num_of_rating": 0,
"tutors": [],
"tags": []
},
{
"bundle_id": 94,
"bundle_name": "Railway-TestSeries",
"course_ids": [],
"bundle_description": "",
"exam_ids": [
"71"
],
"is_test_series": 1,
"cost": 0,
"currency_cost": 0,
"actual_cost": 0,
"currency_actual_cost": 0,
"striked_cost": 0,
"currency_striked_cost": 0,
"position": 1,
"academic_year": 3,
"institution_bundle_id": 99,
"is_online_package": 1,
"student_count": 11,
"fees_template_ids": "8",
"online_registration_allowed": 1,
"free_preview_allowed": 0,
"course_type": 3,
"pretty_name": "Railway-TestSeries",
"course_start_date": 0,
"course_end_date": 0,
"img_url": "",
"stream_id": 1,
"currency_symbol": "$",
"package_cost_set": 1,
"apple_product_id": "2_94",
"rating": 0,
"num_of_rating": 0,
"tutors": [],
"tags": [
{
"id": 12,
"label": "Date2",
"type": 3,
"value": [
"20 Nov 2020"
]
},
{
"id": 16,
"label": "OMOTEC",
"type": 2,
"value": [
"true"
]
},
{
"id": 23,
"label": "Age 9-12",
"type": 1,
"value": [
"Age 9",
"Age 10"
]
}
]
},
{
"bundle_id": 95,
"bundle_name": "Test Package zzz",
"course_ids": [
"23",
"24",
"82"
],
"bundle_description": "Joint Entrance Examination – Advanced (JEE-Advanced),",
"exam_ids": [
"71"
],
"is_test_series": 0,
"cost": 10000,
"currency_cost": 10000,
"actual_cost": 0,
"currency_actual_cost": 0,
"striked_cost": 0,
"currency_striked_cost": 0,
"position": 1,
"academic_year": 3,
"institution_bundle_id": 100,
"is_online_package": 1,
"student_count": 18,
"fees_template_ids": "41",
"online_registration_allowed": 1,
"free_preview_allowed": 1,
"course_type": 1,
"pretty_name": "TestPackage",
"course_start_date": 1633910400,
"course_end_date": 1635120000,
"img_url": "",
"stream_id": 1,
"currency_symbol": "$",
"package_cost_set": 1,
"apple_product_id": "2_95",
"rating": 0,
"num_of_rating": 0,
"tutors": [
{
"tutor_id": 1,
"tutor_name": " Gaurav Kapoor"
}
],
"tags": [
{
"id": 12,
"label": "Date2",
"type": 3,
"value": [
"20 Nov 2020"
]
},
{
"id": 16,
"label": "OMOTEC",
"type": 2,
"value": [
"true"
]
},
{
"id": 23,
"label": "Age 9-12",
"type": 1,
"value": [
"Age 9",
"Age 10"
]
}
]
},
{
"bundle_id": 97,
"bundle_name": "Test Package 4",
"course_ids": [
"23",
"24",
"52",
"82",
"146",
"147",
"148",
"181",
"230",
"231"
],
"bundle_description": "",
"exam_ids": [
"71"
],
"is_test_series": 0,
"cost": 10000,
"currency_cost": 10000,
"actual_cost": 0,
"currency_actual_cost": 0,
"striked_cost": 0,
"currency_striked_cost": 0,
"position": 1,
"academic_year": 3,
"institution_bundle_id": 102,
"is_online_package": 1,
"student_count": 18,
"fees_template_ids": "8,41,42",
"online_registration_allowed": 1,
"free_preview_allowed": 0,
"course_type": 1,
"pretty_name": "TestPackage4",
"course_start_date": 1620086400,
"course_end_date": 1625011200,
"img_url": "",
"stream_id": 1,
"currency_symbol": "$",
"package_cost_set": 1,
"apple_product_id": "2_97",
"rating": 0,
"num_of_rating": 0,
"tutors": [
{
"tutor_id": 1,
"tutor_name": " Gaurav Kapoor"
}
],
"tags": [
{
"id": 12,
"label": "Date2",
"type": 3,
"value": [
"20 Nov 2020"
]
},
{
"id": 16,
"label": "OMOTEC",
"type": 2,
"value": [
"true"
]
},
{
"id": 23,
"label": "Age 9-12",
"type": 1,
"value": [
"Age 9",
"Age 10"
]
}
]
},
{
"bundle_id": 98,
"bundle_name": "Test Package 5",
"course_ids": [
"23"
],
"bundle_description": "",
"exam_ids": [
"71"
],
"is_test_series": 0,
"cost": 1000,
"currency_cost": 1000,
"actual_cost": 0,
"currency_actual_cost": 0,
"striked_cost": 0,
Access: Public, no API key needed. If you send a learner's API key, the catalogue is filtered by the categories they chose at signup (when the institute uses signup categories).
Path parameters
Your institute ID, e.g.
institute/126/courses.Query parameters
searchstring
Matches part of the course name, description or tutor name. No emojis.
product_typestring
Comma-separated product types to list:
1 courses (default), 5 ebooks, 6 test series, 7 playlists.Filter by course tags. Unknown tag names return "Invalid tag names".
tag_categories_joinstring
AND (default) or OR, how tag filters combine.categories_idsstring
Comma-separated category IDs.
tutor_idsstring
Comma-separated tutor IDs.
ratinginteger
Minimum course rating.
pricestring
free or paid.price_arrayJSON string
List of
free, paid and ondemand (enrollment closed).bundle_idsarray of integers
Only these courses.
get_tagsinteger
1 includes each course's tags.get_student_countinteger
1 includes enrolled learner counts.send_bundle_overviewinteger
1 includes each course's long overview.order_bystring
ASC or DESC: secondary sort by course ID after the display order.pageinteger
Page number. Default 1.
per_pageinteger
Results per page. Default is all.
Response:
institute_courses: one entry per organization, withdepartment_nameandcourse_bundles. Each course hasbundle_id,institution_bundle_id,bundle_name,bundle_description,pretty_name,img_url,course_ids,product_type,course_type,is_online_package,costandstriked_cost(in the visitor's currency where international selling is on;-1withpackage_cost_set: 0when no price is set),currency_symbol,position,fees_template_ids,rating,num_of_rating,student_count,course_start_date,course_end_date,online_registration_allowed,is_course_enrollment_allowed,free_preview_allowed,android_registration_allowed,ios_registration_allowed,show_pricing,mb_tutor_id,mb_tutor_nameandtutors.tags: the institute's tag categories and values, for building filters.tutors: tutors who teach the listed courses.countandhas_result, andcourse_classify_by.
Notes: Only courses published in an organization and open for online registration on the platform you call from (website, Android or iOS) are listed. Sorted by the institute's display order. Rate limit: 300 requests per minute; going over locks you out for 30 minutes.