API Documentation

Curriculums

The following requests relate to getting information regarding the academy's curriculums via the Schoox Academy API. Note: All requests must be Authenticated. You can simulate a user's view by his/her schooX ID.

Get a List of Curriculums

Returns a list of all curriculums with extended details.

GET /curriculums

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
userId User's ID you want to retrieve his/her curriculum list view No Integer 3
start Starting Position No Integer 0
limit Max size of retrieved courses No Integer 100
Example Request

https://api.schoox.com/v1/curriculums?apikey=schoox&acadId=386

Response Object
Show All
[{"id":1308,"title":"Innovalearn Curriculum","description":"","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=1308","private":false,"courses":2},{"id":1196,"title":"Red Book Connect SchooX Courses","description":"10 great courses you receive when you purchase SchooX","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/1196\/aSllN50QQkeKAmEXjeAl_Screen Shot 2014-10-14 at 5.18.36 PM.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=1196","private":true,"courses":19},{"id":250,"title":"Curriculum for new employees","description":"This curriculum is to introduce new employee to .... ","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=250","private":false,"courses":3},{"id":39,"title":"Wine Curriculum","description":"Everything about Wine","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/39\/d67d8ab4f4c10bf22aa353e27879133c.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=39","private":false,"courses":3},{"id":38,"title":"Customer Service","description":"A set of courses on how to serve clients. ","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/38\/a5771bce93e200c36f7cd9dfd0e5deaa.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=38","private":false,"courses":3},{"id":37,"title":"Great Food Intro Curriculum","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of Great Food.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=37","private":false,"courses":2}]

Get a List of a User's Curriculums

Returns a list of a user's enrolled & created curriculums with extended details by his/her schooX ID.

GET /curriculums

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
userId User's ID you want to retrieve his/her curriculum list view No Integer 3
external_id Sets whether the userId given is the external_id of the User.
By default, the value is "false"
No String true
start Starting Position No Integer 0
limit Max size of retrieved courses No Integer 100
Example Request

https://api.schoox.com/v1/curriculums?userId=14&apikey=schoox&acadId=386

Response Object
Show All
[{"id":7393,"title":"Demo Training Program","description":"","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=7393","private":true,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":3548,"title":"Information Security Awareness","description":"","image":"d5429d75d4dc8adf839a8f5ec756cc01.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=3548","private":true,"courses":12,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":3211,"title":"test","description":"","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=3211","private":false,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":2615,"title":"Orientation Training Program","description":"This training program consists of three basic courses and it will enhance your skills.","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=2615","private":true,"courses":3,"progress":0,"timespent":"0:00:11","certificates":[]},{"id":2328,"title":"Uniform Multi-language Curriculum","description":"","image":"7966d067d0c6ede39005d10cd957d29f.JPG","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=2328","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":1917,"title":"Global Anti-Corruption","description":"","image":"19a5c5cd37c4c23b4176775f965b484b.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=1917","private":true,"courses":8,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":1747,"title":"Schoox Sales Training","description":"This covers our basic Schoox sales training and documents you will need to be familiar with.","image":"f4cf4e0426d9bc1dc392c39fcd935d64.PNG","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=1747","private":false,"courses":3,"progress":0,"timespent":"0:32:07","certificates":[]},{"id":1715,"title":"Sales Training","description":"This covers our basic Schoox sales training and documents you will need to be familiar with.","image":"3261b6b06a1020dc12e2ad03ccd4cfc8.png","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=1715","private":false,"courses":3,"progress":0,"timespent":"0:03:50","certificates":[]},{"id":1381,"title":"  Sandwich Artist PRO 2.0 ENG","description":"","image":"94e03b45f29cc9a1be478ee9401feab4.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=1381","private":false,"courses":8,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":1308,"title":"Innovalearn Curriculum","description":"","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=1308","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":508,"title":"Social Media Training Program","description":"This training program consist of nine courses from Splash Media University. You will learn all about social media and how you can increase sales through them.","image":"","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=508","private":false,"courses":9,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":338,"title":"MxBaseline Implementation Package","description":"This curriculum includes all the MxBaseline related courses as follows:\r\n\r\n1. Welcome to MacromatiX - Customer Implementation \r\n2. Setup a New Customer - Implementation Guide\r\n3. MacromatiX Day and Week in the Life Operations\r\n4. Store Functions - Quick Guides\r\n5. Head Office - Inventory - User's Guides","image":"Crytf4TTAi0eEQkuw7sp_MxBaseline.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=338","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":218,"title":"Farrelli's Intro","description":"","image":"","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=218","private":false,"courses":4,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":166,"title":"Welcome to Farrelli's:  The Basics","description":"This curriculum includes How to use Schoox\/Farrelli's Academy, Farrelli's Orientation, and the Handbook Power Point and \"exams\" a new hire must pass as a part of the training certification process.","image":"ZagMUlqeSJGOcVkPeCYL_New Logo Fancy Flame!.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=166","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":163,"title":"aaa curriculum","description":"","image":"lFoEYuWRraogdiDD67E1_logo.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=163","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":162,"title":"Curriculum for auto assignement","description":"","image":"","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=162","private":false,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":158,"title":"assign curriculum2","description":"rtetests","image":"PXgsdnY1TkeHoWVIJGle_gourmet-cuisine.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=158","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":157,"title":"testestest","description":"","image":"hxWRYHzLSIiscIbfG7MR_11448_166452276868720_1276937103_n-1.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=157","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":156,"title":"assingment test","description":"","image":"","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=156","private":false,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":150,"title":"Auto assign curriculum","description":"no","image":"","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=150","private":false,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":114,"title":"Basic Training Program","description":"This is our basic training program for all employes.","image":"5fd0b37cd7dbbb00f97ba6ce92bf5add.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=114","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":112,"title":"Basic Training program","description":"This training program is for all our employees","image":"7f6ffaa6bb0b408017b62254211691b5.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=112","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":111,"title":"Management Basics","description":"This curriculum consists of two online courses about management development.","image":"698d51a19d8a121ce581499d7b701668.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=111","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":108,"title":"test image png","description":"","image":"a3c65c2974270fd093ee8a9bf8ae7d0b.png","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=108","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":107,"title":"testimage 4","description":"","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=107","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":106,"title":"testimage 3","description":"","image":"f0935e4cd5920aa6c7c996a5ee53a70f.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=106","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":105,"title":"test image","description":"","image":"65b9eea6e1cc6bb9f0cd2a47751a186f.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=105","private":false,"courses":1,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":104,"title":"test image","description":"","image":"c9e1074f5b3f9fc8ea15d152add07294.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=104","private":false,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":80,"title":"BK's Basic Training Program","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of BK.","image":"f033ab37c30201f73f142449d037028d.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=80","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":79,"title":"Customer Service","description":"This is a basic training program which consists of two courses dealing with customer experience and restaurant service.","image":"d1fe173d08e959397adf34b1d77e88d7.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=79","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":78,"title":"Basic Training Program","description":"This is a basic training program which consists of two courses dealing with customer experience and restaurant service.","image":"35f4a8d465e6e1edc05f3d8ab658c551.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=78","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":73,"title":"Cornerstone's Basic Training Program","description":"This Curriculum consists of three online courses about Women's Health, Headaches and Cancer.","image":"d2ddea18f00665ce8623e36bd4e3c7c5.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=73","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":63,"title":"Basic Training Program","description":"This curriculum consists of three basic courses about restaurant service.","image":"03afdbd66e7929b125f8597834fa83a4.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=63","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":61,"title":"Leadership","description":"Growing in leadership requires understanding personal patterns of interacting with others. It also demands understanding the behavior patterns of those who lead. \u201cPersonal Journey to Leadership\u201d will use self-assessment tools, goal setting strategies and interactive exercises to enhance the participants\u2019 innate leadership skills. Participants will develop and take control of their plans for leadership. They will identify their own personal strengths and areas where development is needed and then take steps on the journey to being a more effective leader.","image":"7f39f8317fbdb1988ef4c628eba02591.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=61","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":60,"title":"Basic Training Program","description":"This curriculum has three basic courses and it is for our employees","image":"072b030ba126b2f4b2374f342be9ed44.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=60","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":57,"title":"Basic Training Program","description":"This program is our first series of basic programs that every employee has to complete","image":"72b32a1f754ba1c09b3695e0cb6cde7f.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=57","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":56,"title":"Basic Training Program","description":"This Training program comes with three of our basics courses, dealing with quality service and food safety.","image":"9f61408e3afb633e50cdf1b20de6f466.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=56","private":false,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":55,"title":"Basic Training Program","description":"This Training program comes with three of our basics courses, dealing with quality service and food safety.","image":"b53b3a3d6ab90ce0268229151c9bde11.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=55","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":53,"title":"test training program","description":"no","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=53","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":47,"title":"Roger Brown's Training Program","description":"This training program has 3 basic courses for every new employee of Roger Brown's Restaurant and Sports Bar.","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=47","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":46,"title":"New Manager Development Program","description":"This curriculum is about manager development","image":"d9d4f495e875a2e075a1a4a6e1b9770f.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=46","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":45,"title":"Staff Training Program","description":"This program is for in-depth staff training for Aroma Thyme Bistro. You will find three courses with lots of videos lectures, for easy viewing on all sorts of topics related to the bistro. Thank you and have fun learning.","image":"6c8349cc7260ae62e3b1396831a8398f.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=45","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":42,"title":"Food Safety Training Program","description":"This the basic training program and has two courses about food safety.","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=42","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":39,"title":"Wine Curriculum","description":"Everything about Wine","image":"d67d8ab4f4c10bf22aa353e27879133c.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=39","private":true,"courses":3,"progress":0,"timespent":"0:32:22","certificates":[]},{"id":37,"title":"Great Food Intro Curriculum","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of Great Food.","image":"a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=37","private":true,"courses":2,"progress":0,"timespent":"0:32:15","certificates":[]},{"id":36,"title":"Basic Training Program","description":"This curriculum has three basic courses, for Buca di Beppo servers","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=36","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":35,"title":"Basic Server Training Program","description":"This curriculum has three basic courses, for Johnny's Pizza servers","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=35","private":false,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":33,"title":"Waiters Training Program","description":"As a Server, you will have day-to-day interaction with our Guests. Sharing your people pleasing personality with our Guests is what service is all about. In addition to buying great food, Guests are buying \"great feelings\". A Guest is sure to visit us again when they have enjoyed a memorable experience.\r\n","image":"182be0c5cdcd5072bb1864cdee4d3d6e.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=33","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":24,"title":"Corporate Training Program 2","description":"test corporate program 2","image":"lUMoTB5XQ1mc24sdg4ZY_Natural_spring_background_5_p.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=24","private":true,"courses":3,"progress":0,"timespent":"0:01:41","certificates":[]},{"id":21,"title":"Restaurant Service","description":"This training program is about restaurant service. You can learn from industry's experts how you can improve your hospitality and gain more satisfied customers.","image":"3c59dc048e8850243be8079a5c74d079.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=21","private":true,"courses":3,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":18,"title":"new TP","description":"","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=18","private":false,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":15,"title":"Online Marketing","description":"A bundle of online courses that helps you understand better online marketing and social media experts.","image":"9bf31c7ff062936a96d3c8bd1f8f2ff3.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=15","private":false,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":14,"title":"Wild Wing Cafe Training Program","description":"This training program gives the ability to better understand the proper way of serving in restaurant","image":"aab3238922bcc25a6f606eb525ffdc56.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=14","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":13,"title":"Red Book Training Program","description":"This training program gives the ability to better understand the proper way of serving in restaurant","image":"c51ce410c124a10e0db5e4b97fc2af39.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=13","private":true,"courses":2,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":8,"title":"test 2","description":"test description","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=8","private":false,"courses":0,"progress":0,"timespent":"0:00:00","certificates":[]},{"id":7,"title":"Test","description":"Description test","image":null,"url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=7","private":false,"courses":0,"progress":0,"timespent":"0:00:00","certificates":[]}]

Get Details for a Curriculum

Returns extended details of a specific curriculum. A user's progress percentage, time spent and enrollment date can be retrieved by his/her schooX ID.

GET /curriculum/:curriculum

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
Example Request

https://api.schoox.com/v1/curriculums/37?apikey=schoox&acadId=386

Response Object
Show All
{"id":37,"title":"Great Food Intro Curriculum","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of Great Food.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=37","private":false,"enrolled":true,"courses":[{"id":11657,"title":"How to serve a table","description":"This course is a set of video lectures with examples and best practices on how to serve a table and take orders. ","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11657\/1369906178531902169.jpg","url":"https:\/\/www.schoox.com\/11657\/how-to-serve-a-table","lectures_num":10,"exams_num":2,"materials_num":0,"progress":0,"time_spent":"0:00:00"},{"id":11673,"title":"Wine 101","description":"This courses is all about wine. If you are new to wine drinking and are looking for some basic, overall wine education, you've come to the right place. And if you've been enjoying wine for some time and are looking for some specific pieces of wine information you are missing, you\u2019ve also come to the right place.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11673\/YhkSx78JTmuDZGsAp9To_wine101.jpg","url":"https:\/\/www.schoox.com\/11673\/wine-101?coupon=graecus","lectures_num":6,"exams_num":0,"materials_num":0,"progress":0,"time_spent":"0:00:00"}]}