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

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
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=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All
[{"id":3787720,"time_added":"2022-01-26 15:19:32","time_modified":"2022-01-26 15:19:32","title":"API - Wikipedia","description":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/bookmarks\/bf35ff5bc89a7836d172e0daec66b5db\/7c969eafb957fa07e63eb7a3feb21eb8_o","tags":[],"rating":0,"provider_name":"Wikipedia","categories":[{"id":377828,"name":"Shared Content","parent_id":null,"parent_name":null}],"views":0,"language":null}]

List of Categories

Returns Academy Content categories

GET /content/categories

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
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=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All
[{"id":377828,"name":"Shared Content","isParentCategory":true,"isChildCategory":false,"parentCategory":0,"childCategories":[]}]

List of Venues

Returns a list of Venues

GET /content/venues

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
start Starting Position No Integer 0
limit Number of Venues to return per request, up to maximum of 20. Default to 20 No Integer 20
search Filters Venues by their name. No String Search Text
Example Request

https://api.schoox.com/v1/content/venues?start=0&limit=20&search=Search%20Text&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Response Object
Show All
[{"id":5, "seats":50, "title":"Venue 1","address":"Athens, Greece","city":"Athens"},{"id":9,"seats":25,"title":"Venue 2","address":"Thessaloniki, Greece","city":"Thessaloniki"}]

List of Timezones

Returns a list of the available Timezones

GET /content/timezones

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/content/timezones?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All
[{"id":1,"value":"Pacific\/Samoa","text":"(GMT-11:00) Midway Island, Samoa","offset":-11},{"id":2,"value":"Pacific\/Honolulu","text":"(GMT-10:00) Hawaii","offset":-10},{"id":3,"value":"America\/Anchorage","text":"(GMT-09:00) Alaska","offset":-9},{"id":4,"value":"America\/Los_Angeles","text":"(GMT-08:00) Pacific Time (US and Canada),Tijuana","offset":-8},{"id":5,"value":"America\/Phoenix","text":"(GMT-07:00) Arizona","offset":-7},{"id":6,"value":"America\/Denver","text":"(GMT-07:00) Mountain Time (US and Canada)","offset":-7},{"id":7,"value":"America\/Mexico_City","text":"(GMT-06:00) Mexico City","offset":-6},{"id":8,"value":"America\/Chicago","text":"(GMT-06:00) Central Time (US and Canada)","offset":-6},{"id":9,"value":"America\/Bogota","text":"(GMT-05:00) Bogota, Lima, Quito","offset":-5},{"id":10,"value":"America\/Indianapolis","text":"(GMT-05:00) Indiana (East)","offset":-5},{"id":11,"value":"America\/New_York","text":"(GMT-05:00) Eastern Time (US and Canada)","offset":-5},{"id":12,"value":"America\/Caracas","text":"(GMT-04:00) Caracas, La Paz","offset":-4},{"id":13,"value":"America\/Halifax","text":"(GMT-04:00) Atlantic Time (Canada)","offset":-4},{"id":14,"value":"America\/Santiago","text":"(GMT-04:00) Santiago","offset":-4},{"id":15,"value":"America\/St_Johns","text":"(GMT-03:30) Newfoundland","offset":-3.5},{"id":16,"value":"America\/Buenos_Aires","text":"(GMT-03:00) Buenos Aires, Georgetown","offset":-3},{"id":17,"value":"America\/Sao_Paulo","text":"(GMT-03:00) Brasilia","offset":-3},{"id":18,"value":"Atlantic\/Azores","text":"(GMT-01:00) Azores","offset":-1},{"id":19,"value":"Atlantic\/Cape_Verde","text":"(GMT-01:00) Cape Verde Is.","offset":-1},{"id":20,"value":"GMT","text":"(GMT) Greenwich Mean Time","offset":0},{"id":21,"value":"Europe\/London","text":"(GMT) Dublin, Edinburgh, Lisbon, London","offset":0},{"id":22,"value":"Africa\/Casablanca","text":"(GMT) Casablanca, Monrovia","offset":0},{"id":23,"value":"Europe\/Prague","text":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","offset":1},{"id":24,"value":"Africa\/Malabo","text":"(GMT+01:00) West Central Africa","offset":1},{"id":25,"value":"Europe\/Warsaw","text":"(GMT+01:00) Sarajevo, Skopje, Sofija, Vilnius, Warsaw, Zagreb","offset":1},{"id":26,"value":"Europe\/Brussels","text":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","offset":1},{"id":27,"value":"Europe\/Amsterdam","text":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","offset":1},{"id":28,"value":"Europe\/Athens","text":"(GMT+02:00) Athens, Istanbul, Minsk","offset":2},{"id":29,"value":"Europe\/Helsinki","text":"(GMT+02:00) Helsinki, Riga, Tallinn","offset":2},{"id":30,"value":"Africa\/Harare","text":"(GMT+02:00) Harare, Pretoria","offset":2},{"id":31,"value":"Asia\/Jerusalem","text":"(GMT+02:00) Jerusalem","offset":2},{"id":32,"value":"Africa\/Cairo","text":"(GMT+02:00) Cairo","offset":2},{"id":33,"value":"Europe\/Bucharest","text":"(GMT+02:00) Bucharest","offset":2},{"id":34,"value":"Africa\/Nairobi","text":"(GMT+03:00) Nairobi","offset":3},{"id":35,"value":"Asia\/Kuwait","text":"(GMT+03:00) Kuwait, Riyadh","offset":3},{"id":36,"value":"Asia\/Baghdad","text":"(GMT+03:00) Baghdad","offset":3},{"id":37,"value":"Asia\/Tehran","text":"(GMT+03:30) Tehran","offset":3.5},{"id":38,"value":"Asia\/Tbilisi","text":"(GMT+04:00) Baku,Tbilisi, Yerevan","offset":4},{"id":39,"value":"Europe\/Moscow","text":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","offset":3},{"id":40,"value":"Asia\/Muscat","text":"(GMT+04:00) Abu Dhabi, Muscat","offset":4},{"id":41,"value":"Asia\/Kabul","text":"(GMT+04:30) Kabul","offset":4.5},{"id":42,"value":"Asia\/Karachi","text":"(GMT+05:00) Islamabad, Karachi, Tashkent","offset":5},{"id":43,"value":"Asia\/Calcutta","text":"(GMT+05:30) Calcutta, Chennai, Mumbai, New Delhi","offset":5.5},{"id":44,"value":"Asia\/Colombo","text":"(GMT+06:00) SriJayawardenepura","offset":6},{"id":45,"value":"Asia\/Katmandu","text":"(GMT+05:45) Kathmandu","offset":5.75},{"id":46,"value":"Asia\/Yekaterinburg","text":"(GMT+05:00) Ekaterinburg","offset":5},{"id":47,"value":"Asia\/Dhaka","text":"(GMT+06:00) Astana, Dhaka","offset":6},{"id":48,"value":"Asia\/Rangoon","text":"(GMT+06:30) Rangoon","offset":6.5},{"id":49,"value":"Asia\/Bangkok","text":"(GMT+07:00) Bangkok","offset":7},{"id":50,"value":"Asia\/Jakarta","text":"(GMT+07:00) Hanoi, Jakarta","offset":7},{"id":51,"value":"Asia\/Novosibirsk","text":"(GMT+06:00) Almaty, Novosibirsk","offset":6},{"id":52,"value":"Asia\/Taipei","text":"(GMT+08:00) Taipei","offset":8},{"id":53,"value":"Asia\/Krasnoyarsk","text":"(GMT+07:00) Krasnoyarsk","offset":7},{"id":54,"value":"Australia\/Perth","text":"(GMT+08:00) Perth","offset":8},{"id":55,"value":"Asia\/Singapore","text":"(GMT+08:00) Kuala Lumpur, Singapore","offset":8},{"id":56,"value":"Asia\/Shanghai","text":"(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi","offset":8},{"id":57,"value":"Asia\/Tokyo","text":"(GMT+09:00) Osaka, Sapporo, Tokyo","offset":9},{"id":58,"value":"Asia\/Irkutsk","text":"(GMT+08:00) Irkutsk, Ulaan Bataar","offset":8},{"id":59,"value":"Asia\/Seoul","text":"(GMT+09:00) Seoul","offset":9},{"id":60,"value":"Australia\/Darwin","text":"(GMT+09:30) Darwin","offset":9},{"id":61,"value":"Australia\/Adelaide","text":"(GMT+09:30) Adelaide","offset":9.5},{"id":62,"value":"Australia\/Sydney","text":"(GMT+10:00) Canberra, Melbourne, Sydney","offset":10},{"id":63,"value":"Asia\/Yakutsk","text":"(GMT+09:00) Yakutsk","offset":9},{"id":64,"value":"Pacific\/Guam","text":"(GMT+10:00) Guam, Port Moresby","offset":10},{"id":65,"value":"Australia\/Hobart","text":"(GMT+10:00) Hobart","offset":10},{"id":66,"value":"Australia\/Brisbane","text":"(GMT+10:00) Brisbane","offset":10},{"id":67,"value":"Asia\/Vladivostok","text":"(GMT+10:00) Vladivostok","offset":10},{"id":68,"value":"Asia\/Magadan","text":"(GMT+11:00) Magadan, Solomon Is., New Caledonia","offset":11},{"id":69,"value":"Pacific\/Fiji","text":"(GMT+12:00) Fiji, Kamchatka, Marshall Is.","offset":12},{"id":70,"value":"Pacific\/Auckland","text":"(GMT+12:00) Auckland, Wellington","offset":12},{"id":71,"value":"Pacific\/Tongatapu","text":"(GMT+13:00) Nukualofa","offset":13},{"id":72,"value":"Asia\/Saigon","text":"(GMT+07:00) Saigon|Ho Chi Minh City","offset":7},{"id":73,"value":"America\/Vancouver","text":"(GMT-07:00) Vancouver","offset":-7},{"id":74,"value":"America\/Edmonton","text":"(GMT-06:00) Edmonton","offset":-6},{"id":75,"value":"Etc\/GMT-9","text":"(GMT-09:00) Alaska, Gambier Islands","offset":-9},{"id":76,"value":"America\/Louisville","text":"(GMT-04:00) Louisville","offset":-4},{"id":77,"value":"Europe\/Kiev","text":"(GMT+03:00) Kiev","offset":3},{"id":78,"value":"Etc\/GMT-7","text":"(GMT-07:00) Mountain Time (US and Canada)","offset":-7},{"id":79,"value":"America\/Toronto","text":"(GMT-04:00) Toronto","offset":-4},{"id":80,"value":"Asia\/Dubai","text":"(GMT+04:00) Dubai","offset":4}]
Response Object
Show All
[{"id":1,"value":"Pacific\/Samoa","text":"(GMT-11:00) Midway Island, Samoa","offset":-11},{"id":2,"value":"Pacific\/Honolulu","text":"(GMT-10:00) Hawaii","offset":-10},{"id":3,"value":"America\/Anchorage","text":"(GMT-09:00) Alaska","offset":-9},{"id":4,"value":"America\/Los_Angeles","text":"(GMT-08:00) Pacific Time (US and Canada),Tijuana","offset":-8},{"id":5,"value":"America\/Phoenix","text":"(GMT-07:00) Arizona","offset":-7},{"id":6,"value":"America\/Denver","text":"(GMT-07:00) Mountain Time (US and Canada)","offset":-7},{"id":7,"value":"America\/Mexico_City","text":"(GMT-06:00) Mexico City","offset":-6},{"id":8,"value":"America\/Chicago","text":"(GMT-06:00) Central Time (US and Canada)","offset":-6},{"id":9,"value":"America\/Bogota","text":"(GMT-05:00) Bogota, Lima, Quito","offset":-5},{"id":10,"value":"America\/Indianapolis","text":"(GMT-05:00) Indiana (East)","offset":-5},{"id":11,"value":"America\/New_York","text":"(GMT-05:00) Eastern Time (US and Canada)","offset":-5},{"id":12,"value":"America\/Caracas","text":"(GMT-04:00) Caracas, La Paz","offset":-4},{"id":13,"value":"America\/Halifax","text":"(GMT-04:00) Atlantic Time (Canada)","offset":-4},{"id":14,"value":"America\/Santiago","text":"(GMT-04:00) Santiago","offset":-4},{"id":15,"value":"America\/St_Johns","text":"(GMT-03:30) Newfoundland","offset":-3.5},{"id":16,"value":"America\/Buenos_Aires","text":"(GMT-03:00) Buenos Aires, Georgetown","offset":-3},{"id":17,"value":"America\/Sao_Paulo","text":"(GMT-03:00) Brasilia","offset":-3},{"id":18,"value":"Atlantic\/Azores","text":"(GMT-01:00) Azores","offset":-1},{"id":19,"value":"Atlantic\/Cape_Verde","text":"(GMT-01:00) Cape Verde Is.","offset":-1},{"id":20,"value":"GMT","text":"(GMT) Greenwich Mean Time","offset":0},{"id":21,"value":"Europe\/London","text":"(GMT) Dublin, Edinburgh, Lisbon, London","offset":0},{"id":22,"value":"Africa\/Casablanca","text":"(GMT) Casablanca, Monrovia","offset":0},{"id":23,"value":"Europe\/Prague","text":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","offset":1},{"id":24,"value":"Africa\/Malabo","text":"(GMT+01:00) West Central Africa","offset":1},{"id":25,"value":"Europe\/Warsaw","text":"(GMT+01:00) Sarajevo, Skopje, Sofija, Vilnius, Warsaw, Zagreb","offset":1},{"id":26,"value":"Europe\/Brussels","text":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","offset":1},{"id":27,"value":"Europe\/Amsterdam","text":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","offset":1},{"id":28,"value":"Europe\/Athens","text":"(GMT+02:00) Athens, Istanbul, Minsk","offset":2},{"id":29,"value":"Europe\/Helsinki","text":"(GMT+02:00) Helsinki, Riga, Tallinn","offset":2},{"id":30,"value":"Africa\/Harare","text":"(GMT+02:00) Harare, Pretoria","offset":2},{"id":31,"value":"Asia\/Jerusalem","text":"(GMT+02:00) Jerusalem","offset":2},{"id":32,"value":"Africa\/Cairo","text":"(GMT+02:00) Cairo","offset":2},{"id":33,"value":"Europe\/Bucharest","text":"(GMT+02:00) Bucharest","offset":2},{"id":34,"value":"Africa\/Nairobi","text":"(GMT+03:00) Nairobi","offset":3},{"id":35,"value":"Asia\/Kuwait","text":"(GMT+03:00) Kuwait, Riyadh","offset":3},{"id":36,"value":"Asia\/Baghdad","text":"(GMT+03:00) Baghdad","offset":3},{"id":37,"value":"Asia\/Tehran","text":"(GMT+03:30) Tehran","offset":3.5},{"id":38,"value":"Asia\/Tbilisi","text":"(GMT+04:00) Baku,Tbilisi, Yerevan","offset":4},{"id":39,"value":"Europe\/Moscow","text":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","offset":3},{"id":40,"value":"Asia\/Muscat","text":"(GMT+04:00) Abu Dhabi, Muscat","offset":4},{"id":41,"value":"Asia\/Kabul","text":"(GMT+04:30) Kabul","offset":4.5},{"id":42,"value":"Asia\/Karachi","text":"(GMT+05:00) Islamabad, Karachi, Tashkent","offset":5},{"id":43,"value":"Asia\/Calcutta","text":"(GMT+05:30) Calcutta, Chennai, Mumbai, New Delhi","offset":5.5},{"id":44,"value":"Asia\/Colombo","text":"(GMT+06:00) SriJayawardenepura","offset":6},{"id":45,"value":"Asia\/Katmandu","text":"(GMT+05:45) Kathmandu","offset":5.75},{"id":46,"value":"Asia\/Yekaterinburg","text":"(GMT+05:00) Ekaterinburg","offset":5},{"id":47,"value":"Asia\/Dhaka","text":"(GMT+06:00) Astana, Dhaka","offset":6},{"id":48,"value":"Asia\/Rangoon","text":"(GMT+06:30) Rangoon","offset":6.5},{"id":49,"value":"Asia\/Bangkok","text":"(GMT+07:00) Bangkok","offset":7},{"id":50,"value":"Asia\/Jakarta","text":"(GMT+07:00) Hanoi, Jakarta","offset":7},{"id":51,"value":"Asia\/Novosibirsk","text":"(GMT+06:00) Almaty, Novosibirsk","offset":6},{"id":52,"value":"Asia\/Taipei","text":"(GMT+08:00) Taipei","offset":8},{"id":53,"value":"Asia\/Krasnoyarsk","text":"(GMT+07:00) Krasnoyarsk","offset":7},{"id":54,"value":"Australia\/Perth","text":"(GMT+08:00) Perth","offset":8},{"id":55,"value":"Asia\/Singapore","text":"(GMT+08:00) Kuala Lumpur, Singapore","offset":8},{"id":56,"value":"Asia\/Shanghai","text":"(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi","offset":8},{"id":57,"value":"Asia\/Tokyo","text":"(GMT+09:00) Osaka, Sapporo, Tokyo","offset":9},{"id":58,"value":"Asia\/Irkutsk","text":"(GMT+08:00) Irkutsk, Ulaan Bataar","offset":8},{"id":59,"value":"Asia\/Seoul","text":"(GMT+09:00) Seoul","offset":9},{"id":60,"value":"Australia\/Darwin","text":"(GMT+09:30) Darwin","offset":9},{"id":61,"value":"Australia\/Adelaide","text":"(GMT+09:30) Adelaide","offset":9.5},{"id":62,"value":"Australia\/Sydney","text":"(GMT+10:00) Canberra, Melbourne, Sydney","offset":10},{"id":63,"value":"Asia\/Yakutsk","text":"(GMT+09:00) Yakutsk","offset":9},{"id":64,"value":"Pacific\/Guam","text":"(GMT+10:00) Guam, Port Moresby","offset":10},{"id":65,"value":"Australia\/Hobart","text":"(GMT+10:00) Hobart","offset":10},{"id":66,"value":"Australia\/Brisbane","text":"(GMT+10:00) Brisbane","offset":10},{"id":67,"value":"Asia\/Vladivostok","text":"(GMT+10:00) Vladivostok","offset":10},{"id":68,"value":"Asia\/Magadan","text":"(GMT+11:00) Magadan, Solomon Is., New Caledonia","offset":11},{"id":69,"value":"Pacific\/Fiji","text":"(GMT+12:00) Fiji, Kamchatka, Marshall Is.","offset":12},{"id":70,"value":"Pacific\/Auckland","text":"(GMT+12:00) Auckland, Wellington","offset":12},{"id":71,"value":"Pacific\/Tongatapu","text":"(GMT+13:00) Nukualofa","offset":13},{"id":72,"value":"Asia\/Saigon","text":"(GMT+07:00) Saigon|Ho Chi Minh City","offset":7},{"id":73,"value":"America\/Vancouver","text":"(GMT-07:00) Vancouver","offset":-7},{"id":74,"value":"America\/Edmonton","text":"(GMT-06:00) Edmonton","offset":-6},{"id":75,"value":"Etc\/GMT-9","text":"(GMT-09:00) Alaska, Gambier Islands","offset":-9},{"id":76,"value":"America\/Louisville","text":"(GMT-04:00) Louisville","offset":-4},{"id":77,"value":"Europe\/Kiev","text":"(GMT+03:00) Kiev","offset":3},{"id":78,"value":"Etc\/GMT-7","text":"(GMT-07:00) Mountain Time (US and Canada)","offset":-7},{"id":79,"value":"America\/Toronto","text":"(GMT-04:00) Toronto","offset":-4},{"id":80,"value":"Asia\/Dubai","text":"(GMT+04:00) Dubai","offset":4}]