API Documentation

Content

The following requests relate to getting information regarding the academy's content via the Schoox Academy API. Note: All requests must be Authenticated.

List of content

Returns Academy Content

GET /content

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
start Starting Position No Integer 0
limit Number of content items to return per request, up to maximum of 20. Default to 20 No Integer 10
order_by Content items ordering. Possible values 'title', 'time_added', 'time_modified'. Default 'time_added' No String time_added
direction Content items ordering direction. Possible values 'asc' / 'desc'. Default 'desc' No String desc
category_id Filters content items by their category id No Integer 1
type_id Filters content items by their type id. Possible values 1 (Web Resources), 2 (Files) No Integer 1
sub_type_id Filters content items by their sub type id. Possible values 1 (Online Video), 2 (Online Document), 3 (Online Article), 4 (Online Photo), 5 (Academic Link), 6 (Website), 7 (Document), 8 (Video), 9 (Image), 10 (Audio), 11 (Scorm) No Integer 1
tags Filters content items by their tags. No String Tag1, Tag2
search Filters content items by their name. No String Search Text
Example Request

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

Response Object
Show All
[{"id":1554086,"time_added":"2017-10-20 17:38:44","time_modified":"2017-10-20 17:38:56","title":"Jeffrey A. Miller \u2013 Kitchen - At an Event","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/c0c746fa5bd5f11943e6bb9608aec24c\/4fd75385851a4fdb7185a7df51b482ab_o","tags":[],"rating":0,"provider_name":null,"categories":[{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":1502415,"time_added":"2017-09-07 20:19:07","time_modified":"2017-09-07 20:19:37","title":"Word Document","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/47d9c3da6ee323ee52fc943bc49d34a7.jpg","tags":[],"rating":0,"provider_name":null,"categories":[{"id":1703,"name":"Food Safety","parent_id":null,"parent_name":null}]},{"id":910510,"time_added":"2016-07-27 19:36:44","time_modified":"2018-04-04 18:34:55","title":"Word Document","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/47d9c3da6ee323ee52fc943bc49d34a7.jpg","tags":["managers"],"rating":5,"provider_name":null,"categories":[{"id":1703,"name":"Food Safety","parent_id":null,"parent_name":null},{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":717046,"time_added":"2016-01-21 20:14:32","time_modified":"2018-01-25 10:11:35","title":"Ultimate Demo","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/45712a91d1eed213d7f50a59c1af99ad.jpg","tags":[],"rating":0,"provider_name":null,"categories":[{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":518073,"time_added":"2015-05-20 19:18:29","time_modified":"2016-07-27 19:34:12","title":"Austin-Opening-Food-Menu1","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/7aedd0d0c8288d404afa6ec0a9af608a_hd.jpg","tags":[],"rating":0,"provider_name":null,"categories":[{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":431637,"time_added":"2014-06-27 19:39:27","time_modified":"2014-06-27 19:39:27","title":"High court refuses to reinstate New York big-soda ban","description":"Appeals panel says city overstepped bounds on size restrictions","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/d15e87e63ea4fd028fe8fce60444a1f3\/30ad11496426c4cedd5945b71ef636cf_o","tags":[],"rating":0,"provider_name":null,"categories":[{"id":12636,"name":"Organization","parent_id":null,"parent_name":null}]},{"id":431352,"time_added":"2014-06-26 16:11:07","time_modified":"2014-06-26 16:11:07","title":"Calhoun","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/77a7b8d2ebce77647c49a18977e749d9_hd.jpg","tags":[],"rating":0,"provider_name":null,"categories":[{"id":1703,"name":"Food Safety","parent_id":null,"parent_name":null}]},{"id":429544,"time_added":"2014-06-19 18:41:42","time_modified":"2014-06-19 18:41:42","title":"Food Safety & Sanitation (DVD)","description":"http:\/\/www.ahlei.org Item Id: 06206DVD01ENGE Whether by chemicals, objects, infestation, or foodborne pathogens, the food you prepare and serve to your guest...","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/f31b859a50730084130fc6d7cb5b653f\/9566439e6e3f382906dac9ca9b690567_o","tags":[],"rating":0,"provider_name":"Youtube","categories":[{"id":1703,"name":"Food Safety","parent_id":null,"parent_name":null}]},{"id":429445,"time_added":"2014-06-19 14:41:01","time_modified":"2014-06-19 14:41:01","title":"Wine Tip - How to open a Bottle of Wine the Correct Way","description":"Miguel Garza owner of Vinum Populi offers Wine Tasting Tip # 4 - How to properly open a bottle Of Wine. More Wine Tasting Tips @ winetasterstv.com wine, wine...","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/2bbf897b802e7982fdc4761dff19ff78\/b031ee2581abdbf0990d90ed816539f7_o","tags":[],"rating":0,"provider_name":"Youtube","categories":[{"id":1702,"name":"Alcohol Serving","parent_id":null,"parent_name":null}]},{"id":415179,"time_added":"2014-04-17 17:57:08","time_modified":"2014-04-17 17:57:08","title":"food safety","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/6f1fe01e2993ab8f5f5d9d6606bf379a_hd.jpg","tags":[],"rating":0,"provider_name":null,"categories":[{"id":1702,"name":"Alcohol Serving","parent_id":null,"parent_name":null}]},{"id":409669,"time_added":"2014-03-03 18:14:20","time_modified":"2014-03-03 18:14:19","title":"Top 6 Ways to Get An Angry Customer to Back Down","description":"6 Quick tips to help you diffuse anger and create calm with unhappy customers. This video is part of the \"Golden Method\" elearning course for handling diffic...","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/0a306402e1dac35cdcad6acbe6d10ebc\/407e152ed834e8742399d1a0cde8e224_o","tags":["angry","customers"],"rating":0,"provider_name":"Youtube","categories":[{"id":1702,"name":"Alcohol Serving","parent_id":null,"parent_name":null}]},{"id":409656,"time_added":"2014-03-03 16:38:48","time_modified":"2014-03-03 16:38:48","title":"How to Provide Extraordinary Customer Service: The Fred Factor","description":"Do you provide exceptional customer service? Is the customer service in your company extraordinary? Fred Shea, a Denver postman, was the inspiration for Mark...","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/1ec1b0a1595df90ccddeb107cf6092a2\/32b1db08e6682f23672518caeb6927f8_o","tags":["customer","extraordinary","provide","service"],"rating":0,"provider_name":"Youtube","categories":[{"id":1704,"name":"Customer Service","parent_id":null,"parent_name":null}]},{"id":372738,"time_added":"2014-01-07 14:14:53","time_modified":"2014-01-15 09:12:12","title":"How to Serve Absinthe - Liquor.com","description":"How to Cocktail: Absinthe. Rumor has it that drinking absinthe can drive you mad, but Simon Ford reveals the truth behind this 200-year-old elixir. Learn how...","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/1d01f9b391aaf18c2ef5b5613c936754\/bd74026ba1babcd6c37ef19843aca251_o","tags":["absinthe"],"rating":0,"provider_name":"Youtube","categories":[{"id":1702,"name":"Alcohol Serving","parent_id":null,"parent_name":null}]},{"id":294911,"time_added":"2014-01-02 10:10:52","time_modified":"2014-01-15 09:12:12","title":"Jamie Oliver live, second webcast - salads I","description":"Recorded 1st June 2011 at Jamie's home. Interesting video","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/605ea340cf4a700127484df4eae0c835\/fc79a311538bf86d2cefc9b40f3e87c6_o","tags":["salads"],"rating":0,"provider_name":"Youtube","categories":[{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":56997,"time_added":"2013-12-29 12:55:32","time_modified":"2014-01-15 09:12:12","title":"Bill would make rules on serving alcohol tougher","description":"A fatal crash that killed one teen and injured another could change state law by toughening the rules for anyone who serves alcohol in Nebraska.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/304a5e3d842ce478bb622167fdaae333\/341cc906916b979c80fdd2904594c9db_o","tags":["alcohol","serving"],"rating":0,"provider_name":"Youtube","categories":[{"id":1702,"name":"Alcohol Serving","parent_id":null,"parent_name":null}]},{"id":44335,"time_added":"2013-12-29 12:25:20","time_modified":"2014-01-15 11:13:37","title":"Tips on serving alcohol","description":"The following are tips that one might encounter while serving at a bar. A nice short intro video.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/a3198a2debd0f0ccf1ced032205abfed\/37ea63cea9c467b689b642e744a45cea_o","tags":["alcohol","serving","tips"],"rating":0,"provider_name":"Youtube","categories":[{"id":1702,"name":"Alcohol Serving","parent_id":null,"parent_name":null}]},{"id":56993,"time_added":"2013-12-24 10:43:21","time_modified":"2014-01-15 11:13:37","title":"Myths and misconceptions about evolution - Alex Gendler","description":"View full lesson: http:\/\/ed.ted.com\/lessons\/myths-and-misconceptions-about-evolution-alex-gendler How does evolution really work? Actually, not how some of o...","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/d37533b2e25d3a0698001962512477c0\/45cd880b90cbc627464d5e93b0298949_o","tags":["Myths","evolution","misconceptions"],"rating":0,"provider_name":"Youtube","categories":[{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":16057,"time_added":"2013-11-26 14:52:07","time_modified":"2014-01-08 12:47:50","title":"How to serve customers with disabilities","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/modified\/b68e2ee01f88bb25d5a2d13331ea7e2e.jpg","tags":["disabilities","serving"],"rating":0,"provider_name":null,"categories":[{"id":1704,"name":"Customer Service","parent_id":null,"parent_name":null},{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":16056,"time_added":"2013-10-05 14:28:29","time_modified":"0000-00-00 00:00:00","title":"Hygienic Food Preparation","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/modified\/28259bc3f115efd8df96546a35d67ab3.jpg","tags":["food","safety"],"rating":0,"provider_name":null,"categories":[{"id":1703,"name":"Food Safety","parent_id":null,"parent_name":null},{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]},{"id":16055,"time_added":"2013-10-05 14:28:11","time_modified":"2014-01-08 12:47:50","title":"Customer Service","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/files\/thumb\/97a298d2a338c5ed3f6ea309cbcf4733_hd.jpg","tags":["serving"],"rating":0,"provider_name":null,"categories":[{"id":1704,"name":"Customer Service","parent_id":null,"parent_name":null},{"id":380,"name":"Shared Content","parent_id":null,"parent_name":null}]}]

List of categories

Returns Academy Content categories

GET /content/categories

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
limit Number of content items to return per request, up to maximum of 20. Default to 20 No Integer 10
search Filters content items by their name. No String Search Text
Example Request

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

Response Object
Show All
[{"id":380,"name":"Shared Content","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]},{"id":10709,"name":"Alcohol Regulations","isParentCategory":false,"isChildCategory":true,"parentCategory":7454,"childCategories":[]},{"id":1702,"name":"Alcohol Serving","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]},{"id":1704,"name":"Customer Service","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]},{"id":166256,"name":"DELETE","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]},{"id":25725,"name":"Dry Storage","isParentCategory":false,"isChildCategory":true,"parentCategory":12636,"childCategories":[]},{"id":7455,"name":"Food Safety","isParentCategory":false,"isChildCategory":true,"parentCategory":7454,"childCategories":[]},{"id":1703,"name":"Food Safety","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]},{"id":33898,"name":"For Admins","isParentCategory":false,"isChildCategory":true,"parentCategory":33897,"childCategories":[]},{"id":33900,"name":"For All Users","isParentCategory":false,"isChildCategory":true,"parentCategory":33897,"childCategories":[]},{"id":33899,"name":"For Training Managers","isParentCategory":false,"isChildCategory":true,"parentCategory":33897,"childCategories":[]},{"id":25727,"name":"Freezer","isParentCategory":false,"isChildCategory":true,"parentCategory":12636,"childCategories":[]},{"id":7456,"name":"Manager","isParentCategory":false,"isChildCategory":true,"parentCategory":7454,"childCategories":[]},{"id":12636,"name":"Organization","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[12637,25725,25727]},{"id":12637,"name":"Pantry","isParentCategory":false,"isChildCategory":true,"parentCategory":12636,"childCategories":[]},{"id":7454,"name":"Regulations","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[7455,7456,10709]},{"id":33897,"name":"Schoox How-To","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[33898,33899,33900]},{"id":1705,"name":"Wine","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]}]