Institution Info
Returns your institute's public profile and settings: name, logos, contact details, links, branding and which features are switched on. Use it when building a website or app for the institute, for example to show the right logo and decide whether to offer signup, OTP login or Google login.
GET
/institute/instituteinfoInstitution Info
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/institute/instituteinfo?host_name=<hostname>'{
"code": 200,
"message": "Success",
"inst_info": {
"institute_id": 126,
"name": "Edmingle",
"api_end_host": "prashant-api.edmingle.com",
"title": "",
"portal_name": "prashant",
"logo_details": [
{
"logo_id": 121,
"logo_institute_id": 126,
"logo_field_id": null,
"logo_url": "https://d3qkixnfotqhhy.cloudfront.net/assets/client_logos_auto/n-logo.png",
"logo_type": 2,
"logo_height": "75px",
"logo_width": "",
"background_color": "",
"style": ""
},
{
"logo_id": 267,
"logo_institute_id": 126,
"logo_field_id": 1596031,
"logo_url": "https://dme2wmiz2suov.cloudfront.net/Institution(126)/Logo/1596031-Logo.png",
"logo_type": 1,
"logo_height": "",
"logo_width": "120px",
"background_color": "",
"style": "margin:-5px 10px 0 0"
}
],
"contact_number": "9999999999",
"address_1": "DLT",
"address_2": "",
"city": "Bangalore",
"state": "DELHI",
"country": "IN",
"pincode": "560005",
"support_email": "support@edmingle.com",
"portal_link": "https://demoacademy.edmingle.com",
"show_courses": 1,
"streams_visible": 1,
"aboutus_visible": 1,
"ios_link": "https://play.google.com/store/apps/details?id=com.edmingle.engageapp&hl=en_IN&gl=US",
"android_link": "https://play.google.com/store/apps/details?id=com.edmingle.engageapp&hl=en_IN&gl=US",
"enable_credit_system": 0,
"is_live_classes_enabled": 1,
"is_shopclients_enabled": 0,
"shopclients_authtoken": null,
"enable_signup": 1,
"payment_gateway": "8",
"max_login_allowed": 100,
"biometric_enabled": 0,
"enable_gst": 1,
"map_owners": 1,
"enable_id_card": 0,
"enable_my_payments": 1,
"enable_buy_now": 1,
"ispring_cloud_enabled": 1,
"facebook_app_id": null,
"enable_otp_signup": 0,
"show_student_rank": 1,
"enable_video_download_android": 1,
"enable_teacher_calling": 1,
"enable_issue_certificate": 0,
"course_info_buy_blocked": 0,
"enable_fb_login": 1,
"enable_google_login": 1,
"terms_condition_url": "https://demoacademy.edmingle.com/terms-and-conditions",
"privacy_policy_url": "https://demoacademy.edmingle.com/privacy-policy",
"about_us_url": null,
"enable_student_profile_pic_update": 1,
"institution_subdomain": "demoacademy",
"host_name": "demoacademy.edmingle.com",
"fb_url": "https://facebook.com/voodoo_harper",
"linked_url": "https://www.linkedin.com/login",
"twitter_url": "https://twitter.com/voodoo_harper",
"ig_url": "https://instagram.com/adi0014",
"youtube_url": "https://www.youtube.com/",
"gplus_url": "",
"favicon_file_url": "https://dme2wmiz2suov.cloudfront.net/Institution(126)/Logo/1499759-logo_for_Demo.png",
"website_scripts": "<script></script>",
"website_custom_style": "\n<style>\n.nav-utility.bg-dark .module.left, .footer-1 .col-md-3:last-child p{\n display:none;\n}\n.module-group.right .menu>li:first-child {\n display: none;\n}\n\n</style>",
"free_enrol_btn_text": "Enroll free",
"is_website_builder_set": 1,
"remove_bottom_edmingle_logo": 0,
"is_ssl_enabled": 1,
"restrict_future_signin": 0,
"allow_admin_virtualclass_signin": 0,
"enable_certificate_tab": 1,
"enable_certificate_verification": 1,
"privacy_policy": null,
"terms_conditions": null,
"terms_conditions_url": null,
"signup_primary_field": 2,
"institution_currency": 1,
"actual_domain": "",
"client_enabled_gst": 1,
"logout_url": "https://prashant.edmingle.com",
"student_logo_url": "",
"tutor_block_confidential_field": 1,
"is_tutor_tnc_enabled": 0,
"tutor_terms_and_conditions": "<p>Privacy Policies\n</p><p>\n</p><p><br></p><p>The terms \"We\" / \"Us\" / \"Our\"/โCompanyโ individually and collectively refer to Demo Academy. and the terms \"You\" /\"Your\" / \"Yourself\" refer to the users.\n</p><p>This Privacy Policy is an electronic record in the form of an electronic contract formed under the information Technology Act, 2000 and the rules made thereunder and the amended provisions pertaining to electronic documents / records in various statutes as amended by the information Technology Act, 2000. This Privacy Policy does not require any physical, electronic or digital signature.\n</p><p>This Privacy Policy is a legally binding document between you and Demo Academy. (both terms defined below).</p><p>\n</p><p>\n</p><p>\n</p><p>\n</p><p>\n</p><p>\n</p><p>\n</p><p>\n</p>",
"enable_course_welcome_invoice_attachment": 1,
"enable_invoice_attachment": null,
"is_sso_enabled": 0,
"sso_client_url": "https://demoacademy.edmingle.com/edminglesandbox/ssotest.php",
"enable_student_mark_material_as_completed": 1,
"inst_base_currency_id": 49,
"inst_international_selling_status": 1,
"allow_course_access_branches": 0,
"enable_website_builder": 1
},
"website_info": [
{
"website_page_id": 299,
"page_type": 1,
"show_page": 1,
"page_title": "Demo Portal - Learn, Test and Explore our academy.",
"page_description": "For demo purpose only.",
"page_keywords": "1233",
"privacy_policy": "",
"privacy_policy_url": "https://dme2wmiz2suov.cloudfront.net/Institution(126)/WebsiteFiles/1592722-privacy_policy_inst_126.html?Expires=1685073481&Signature=WJiqRlBtivhNbNtQSP4NK1HicB6GgYz-~exCk6mLtIfE5TKiURMtE4SEWR6ZS-9dDjxTNeCJQfVcbc4F42U4WGU2IRgubiH5NIWKl~wa8H04A7BzWOWWoiBHkLpADxCMGakbKMB5NgjeEe9iN4foL2nbQ5PNV9dNQNFSfgKrMqb-tvGJkhKF92TIpF5EvluctY~FoK6MPIChKRUUOe~aB5vxJn-LkWklVcJU51iBG1DHoG01c~riR3kk4HxtvCza7dTueOBNoTfI0lIdY0-TFrMBgKxoJUoPzXod95ctM4k~~OCScTHvTOaJgMXAdRAGXWntYbSHO~vgNXWW1WVNKQ__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA",
"terms_conditions": "",
"terms_conditions_url": "https://dme2wmiz2suov.cloudfront.net/Institution(126)/WebsiteFiles/1592723-terms_conditions_inst_126.html?Expires=1685073481&Signature=Pl8IuuImuphL~AGsjTCl2C5nAp9LOEP~DGovu6osboxXGSpaTGug2KUyNh3vDmWeONyhqUZ1yVgmdS~VwHq6DdetNjlvZoKjbFbP6OLQ5Ao75BGhnVud88pnxnX8Fsm9P9j9NVH3TLnw-gj2ATHHGX0Pf7A086PlnYBOYEwVtcNH4XuGY5nI8P1JoYPw4f7~hefOKrfgLPdXFezGCHACmzSh61RYA7Sz2DDMyYJOxtR0YTRe4xCnLIT4pgEbWFsYrXwjCmC6e8Bf8wWYZuBzDdIzzzFxVMQS6fyhw7ueeYn9C8a4Q~GZOcUUa09Qe3GuRnuccSONBhoa4at8lUB8PA__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA",
"website_sections": [
{
"website_section_id": 1790,
"section_type": 5,
"show_section": 1,
"heading": "Test Section",
"sub_heading": "",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "<marquee direction=\"left\" height=\"100%\" width=\"100%\" bgcolor=\"white\"><img src=\"https://dme2wmiz2suov.cloudfront.net/User(3846680)/website_media/image/962902--?Expires=1653559081&Signature=aIrLxxEzkSac5BKJF5QllmaDgI34IbIDnEYTIwobwxRA-Akp6rlUMbHd9vExs1uNBUSN0hEDHq3ugmf8J9I1Lnman82aTsllOYMqiKBcxVPxbcvxHPuExUWs68gT9tYBf2J9xHdwZb9mDpVMzexiT2Eem4UE519jYRvDh9i8uscEi0MztTF~IdcLHrYgTjzxK4JFDpXuFgzYS9wQxIKIv~yQc1adGNu6AdPOOaWBzpzckCmiD08dlako103fMmJsrc0IqqmOWPFc4qvLtMiaB02FqezqOpJ7ejtlTuQAEvNX2xfbz8e3-AxG4go-hFMUIDYxsMwH6TatG3MwRDyftA__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA\" data-filename=\"Untitled design (8).png\" style=\"width: 25%;\"><img src=\"https://dme2wmiz2suov.cloudfront.net/User(3846680)/website_media/image/962903--?Expires=1653559081&Signature=cZX~OaiGkgADK~oM4fKF9I~qHh2YwOO0NR3CQULJgzH-KTWa-Zf8pBbnu12NlPrbct4q3TSeQJd9Y-RO7VSyqd1BliEfwsnDhvu1TtO6R~zTfhWC-Mqm024lrj7KQzzMMpQKwD2rEN186CAgW2gwFw3DeweXe8AmmSGo9ucqtx5GiYBTg3nKvOtQAffJ~BzZA7bcbUaHD5i~0nxmf-w5DOL~cJ9gDdiSzIwF6u4jMrVmF8lDwFIfRvOIbLYE3acFOFGY0TVpKrPWGLV5XnjXx31XXc8r2H4jeG0Pzc9j8f48r-s0ZlSy~IGT7tXY~A4lPY4b7xXO9bpb0WwM8l9jnQ__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA\" data-filename=\"Untitled design (5).png\" style=\"width: 25%;\"><img src=\"https://dme2wmiz2suov.cloudfront.net/User(3846680)/website_media/image/962904--?Expires=1653559081&Signature=ytJE09yzNJrdHQRC~i-AEPNwJA3MeUKVlDdhBqP9h7ji9BGJWb8hxbl6MugiR3osF-61Q1sJe3vsvuyIk1OLI~ZlRlEFnlRFzfkVu8i0j45klS3U1eIT~ntO77LTawc8~RrECTi5A74KBrOxvXw4D8sOFLPCC~Zc9g0yENRXzTN2dpmbFWuNqV3fvPFInPTdhIcJzT559ZnXaDYl6uV3WylbqSq0fC80exIr-Hft8chNsZxzdxXJufLqwurwA88~~q~oellZeXhMx2FN-SMaEPTHfK3rCaOvWZebgYHxR2PKuKoZWji59HSIsX~yaNRdpC4Z-5M1pm7N1YDmBtD75w__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA\" data-filename=\"Untitled design (4).png\" style=\"width: 25%;\"><span style=\"font-size: 18px;\"></span><img src=\"https://dme2wmiz2suov.cloudfront.net/User(3846680)/website_media/image/962905--?Expires=1653559081&Signature=HsRsj6LLDJzddjoNSUbxhcBktqhPBaoGQzZA22~XTzKDO0n3eNdKpK6LZxUebPUq2zyMQwuscFiLSDmmk65eYyyXepgIjAsfklTdjiRvD11KkKDuo2NkprGSt3rJuqQZ4bwvI-M05Zl2~DzbVwko7zuR7Cga8Ggzp-m0paaSilbpuNQf1PJ9~XJ-XdqOJPRZhvm-HUxTe6XY1DOlPiJgMEu3~wF5oy5~Zkm497EtFZkIyeABlEv-mRFLiirNYK6xma0Tje1GFcof1~b27yMeWVqkGZg7R~txhBR1ZqwZkIDc-lZIbwpIzoQHN2RLze2H2qZwXcenvXUEu0SAsHbCbg__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA\" data-filename=\"Untitled design (7).png\" style=\"width: 25%;\"><br></marquee>\n",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 1206,
"section_type": 1,
"show_section": 1,
"heading": "A Leading institute of education",
"sub_heading": "An ideal destination to prepare for your future",
"button_text": "Explore Courses",
"cta": 0,
"background_image_id": 1497132,
"background_image_url": "https://dme2wmiz2suov.cloudfront.net/Institution(126)/Logo/1497132-Website.jpg",
"section_html": "",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 1207,
"section_type": 2,
"show_section": 1,
"heading": "Courses Offered",
"sub_heading": "Explore our highly curated courses by expert faculty",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 1208,
"section_type": 3,
"show_section": 1,
"heading": "About Us",
"sub_heading": "sdfghjfghfgh",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "<p></p><p>Edmingle’s powerful, easy to use and All-In-One technology will help you quickly set up your online courses, promote them on your website or app and grow your online student community.</p>\n",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 1209,
"section_type": 4,
"show_section": 0,
"heading": "Get in Touch with Me",
"sub_heading": "Hello hhhhh",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "",
"show_address": 1,
"show_contact_number": 1,
"show_email": 1,
"show_enquiry_form": 1
},
{
"website_section_id": 3085,
"section_type": 5,
"show_section": 0,
"heading": "Youtuber",
"sub_heading": "",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 2439,
"section_type": 5,
"show_section": 1,
"heading": "FAQ",
"sub_heading": "",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 3849,
"section_type": 5,
"show_section": 0,
"heading": "Footer",
"sub_heading": "",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "<footer class=\"footer-1 bg-secondary portal-footer\">\n <div class=\"container\">\n <div class=\"row\">\n <div class=\"col-md-3 col-sm-4 text-center\">\n <img class=\"footer-logo\" src=\"\">\n\n <br>\n </div>\n <div class=\"col-md-3 col-sm-4\">\n <div class=\"widget\">\n <h6 class=\"title\">Useful Links</h6>\n <hr>\n <ul class=\"link-list\">\n\n <li><a href=\"#courses%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20\">Courses</a>\n </li>\n <li><a href=\"#contact-us%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20\">Contact Us</a>\n </li>\n <li>\n <a href=\"#\" class=\"register-btn open-login\" style=\"display: inline-block;\">Log In</a>\n </li>\n <li class=\"app-link access-app-btn\" style=\"display: none;\">\n <a href=\"https://learning.datatrained.com/app/\">My Courses</a>\n </li>\n </ul>\n </div>\n </div>\n\n <div class=\"col-md-3 col-sm-4\">\n <div class=\"widget\">\n <h6 class=\"title\">Other Links</h6>\n <hr>\n <ul class=\"link-list\">\n <li>\n <a href=\"https://learning.datatrained.com/terms-and-conditions\" key=\"nu_tou\">Terms and Conditions</a> </li>\n <li>\n <a href=\"https://learning.datatrained.com/privacy-policy\">Privacy Policy</a>\n </li>\n </ul>\n </div>\n </div>\n\n <div class=\"col-md-3 col-sm-4\">\n <div class=\"widget\">\n <h6 class=\"title\" key=\"nu_get_in_touch\">Get In Touch</h6>\n <hr>\n <p>\n support@datatrained.com <br>\n <br>\n </p>\n\n <ul class=\"list-inline social-list\">\n </ul>\n </div>\n <!--end of widget-->\n </div>\n\n </div>\n <!--end of row-->\n\n </div>\n <!--end of container-->\n <a class=\"btn btn-sm fade-half back-to-top inner-link\" href=\"#top\" key=\"nu_top\">Top</a>\n </footer>\n",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 4156,
"section_type": 5,
"show_section": 1,
"heading": "Custom Area",
"sub_heading": "",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "<h1 style=\"text-align:center;\">A Centered Heading</h1><p style=\"text-align:center;\">Centered paragraph.</p>\n",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 5320,
"section_type": 5,
"show_section": 0,
"heading": "Gaurav Video",
"sub_heading": "",
"button_text": null,
"cta": 0,
"background_image_id": 0,
"background_image_url": null,
"section_html": "<div style=\"max-width:100%;text-align:center;\">\n<iframe style=\"max-width:100%;padding:20px;\" src=\"https://www.youtube.com/embed/tPSz-9qnlig\" title=\"YouTube video player\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen=\"\" width=\"1080\" height=\"560\" frameborder=\"0\"></iframe><br>\n</div>\n",
"show_address": 0,
"show_contact_number": 0,
"show_email": 0,
"show_enquiry_form": 0
},
{
"website_section_id": 5393,
"section_type": 5,
"show_section": 0,
"heading": "About us",
"sub_heading": "",
"bAccess: Public, no API key needed.
Query parameters
Your portal's host name without
https://. For the portal https://demoacademy.edmingle.com/, send demoacademy.edmingle.com. Custom domains work too.get_file_databoolean
true includes file details in website_info.Response: inst_info holds the institute profile and settings, including:
- Identity:
institute_id,name,title,portal_name,portal_link,host_name,actual_domain,institution_subdomain,api_end_host,logo_details(each logo'slogo_url,logo_type, size and style),student_logo_url,favicon_file_url,brand_colour. - Contact:
contact_number,support_email,address_1,address_2,city,state,country,pincode, and social links (fb_url,twitter_url,ig_url,linked_url,youtube_url). - Apps and policies:
android_link,ios_link,terms_condition_url,privacy_policy_url,about_us_url. - Sign-in and signup:
enable_signup,signup_primary_field,enable_otp_login,enable_otp_signup,enable_google_login,enable_fb_login,enable_azure_ad_login,is_sso_enabled,sso_client_url,is_saml_sso_enabled,enable_multi_factor_authentication. - Commerce:
institution_currency,inst_base_currency_id,inst_international_selling_status,payment_gateway,enable_gst,enable_buy_now. online_organization_idandonline_organization_name: the institute's default online organization.- Other feature flags such as
events_enabled,membership_enabled,community_enabled,blogs_enabledandenable_website_builder.
The response also has website_info (website builder pages and sections) and paymentinfo (is_edmingle_payment_gateway, is_bank_added).
Notes: When called from a branch-specific domain, the name, links and some settings come from that branch. Returns "Institute Not Found" if host_name is missing.