API Documentation

Groups

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

List of Groups

Returns a list of all academy groups

GET /groups

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 courses to return per request, up to maximum of 20. Default to 20 No Integer 20
Example Request

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

Response Object
Show All
{"groups":[{"group_id":182,"title":"Alcohol Serving","description":"How to serve Alcohol responsible","date_add":"2013-02-10 08:24:44","modified_at":"2019-12-06 12:17:30","visible":"1","public":"1","enabled":"1","code":null,"category":"-1","thumb":"68dcb058abab02873d1026bacfa6e023.jpg","cover":null,"discussions":"1","members":"4","owner":"4","content":"1","wall":null,"name":null,"institution_id":"386","visible_d":"-1","visible_db":"1","everyone":null,"introduction":""},{"group_id":180,"title":"Customer Service - How to improve tips","description":"This group is to share experience on how to better serve customers and improve tips. ","date_add":"2013-02-10 08:12:08","modified_at":"2019-12-06 12:17:30","visible":"1","public":"1","enabled":"1","code":null,"category":"-1","thumb":"30e949941e1e3fdb43af9e209214a24f.jpg","cover":null,"discussions":"0","members":"4","owner":"4","content":"1","wall":null,"name":null,"institution_id":"386","visible_d":"1","visible_db":"-1","everyone":null,"introduction":""}]}

Associate user with group

Associates a list of users to a group. Max 10 users per request

PUT /groups/:groupid/associate

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/groups/1/associate?apikey=schoox&acadId=386

Request Object
Show All
{"user_ids":[1,2,3,4]}