API Documentation
Training Dashboard- Training Dashboard
- List of Users
- List of a User's Courses
- List of a User's Curriculums
- List of a User's Exams
- List of Courses
- List of Enrolled Users in a Course
- Course Progress for a User
- List of Curriculums
- List of Enrolled Users in a Curriculum
- Curriculum Progress for a User
- List of Exams
- List of Enrolled Users in an Exam
- Courses
- Exams
- Events
- Curriculums
- Users
- Users
- List of Users
- Details of a User
- List User's Badges
- Create & Add a User
- Bulk Create & Add Users
- Invite a User
- Bulk Invite Users
- Edit a User
- Remove a User
- Reactivate a User
- Add a New Job
- Bulk New Jobs
- Edit a Job
- Delete a Job
- List Jobs
- Update User's Roles
- Update User's Jobs
- Add Units to a User
- Remove Unit from a User
- Add Above Units to a User
- Remove Above Unit from a User
- Add a New Type
- Bulk New Types
- Edit a Type
- Delete a Type
- List Types
- Add a New Above Unit
- Bulk New Above Units
- Edit an Above Unit
- Delete an Above Unit
- List Above Units
- Add a New Unit
- Bulk New Units
- Edit a Unit
- Delete a Unit
- List Units
- Archive a Unit
- Unarchive a Unit
- Delete an Archived Unit
- List Archived Units
- Assign Courses
Users
The following requests relate to getting information about users via the Schoox Academy API. Note: All requests must be Authenticated. Access Level for all requests: Administrators, Training Managers, Region and Location Managers. Depending on the role the requests return data either for all users (Access level: Administrators and Training Managers) or for users that belong to a certain region or location (Access Level: Region Managers, Local Managers). You can simulate a user's view by his/her schooX ID.
Get a List of Users
Returns a list of academy's users. A role must be specified. Available values are: employee, customer, instructor & member.
GET /users
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| role | Role of users | Yes | String | employee |
| past | List Past Employees if given role is "employee". Default value is "false" | No | String | Yes |
| search | Search by user's firstname or lastname | No | String | Bill |
| aboveId | Above Unit's ID | No | Integer | 1 |
| unitId | Unit's ID | No | Integer | 4 |
| jobId | Job's ID | No | Integer | 7 |
| start | Starting Position | No | Integer | 0 |
| limit | Number of users to return per request, up to maximum of 100. Default to 100 | No | Integer | 100 |
Example Request
https://api.schoox.com/v1/users?role=employee&apikey=schoox&acadId=386
Response Object
Show All
[{"id":239905875,"firstname":"ZoubinHS","lastname":"ZoubinHS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=239905875"},{"id":1290654741,"firstname":"Chris","lastname":"Zorich","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1290654741"},{"id":1189680775,"firstname":"Benjamin","lastname":"Ziegler","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1189680775"},{"id":1619451059,"firstname":"Tammie","lastname":"Zeus","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1619451059"},{"id":1354672726,"firstname":"Rosa","lastname":"Zavala","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1354672726"},{"id":194857321,"firstname":"Jose","lastname":"Zavala","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=194857321"},{"id":2014132245,"firstname":"DENISE","lastname":"ZAMORANO\u00c2\u00a0","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2014132245"},{"id":1686051243,"firstname":"DENISE","lastname":"ZAMORANO","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1686051243"},{"id":1760504639,"firstname":"Maria T","lastname":"Zaldivar","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1760504639"},{"id":1742462806,"firstname":"DAVID","lastname":"YOUNGBERG","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1742462806"},{"id":1882020130,"firstname":"Angus","lastname":"Young","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1882020130"},{"id":593661232,"firstname":"JESSICA","lastname":"YOUNG","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=593661232"},{"id":1472415040,"firstname":"Vince","lastname":"Young","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1472415040"},{"id":1717629516,"firstname":"Valerie","lastname":"Young","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1717629516"},{"id":1689029017,"firstname":"Malcom","lastname":"Young","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1689029017"},{"id":506235339,"firstname":"Prida","lastname":"You","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=506235339"},{"id":2068535215,"firstname":"Stephanie","lastname":"Yoo","username":"","email":"api@schoox.com","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2068535215"},{"id":775754518,"firstname":"GRANT","lastname":"YETTER","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=775754518"},{"id":1202892831,"firstname":"Kimo","lastname":"Yee","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1202892831"},{"id":104805461,"firstname":"MIKE","lastname":"YAMBAO","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=104805461"},{"id":410563604,"firstname":"X","lastname":"X","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=410563604"},{"id":1573996473,"firstname":"Trish","lastname":"X","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1573996473"},{"id":1017400416,"firstname":"Brent","lastname":"Wulf","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1017400416"},{"id":1691336375,"firstname":"Yvette","lastname":"Wrightman","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1691336375"},{"id":52470362,"firstname":"Tom","lastname":"Wright","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=52470362"},{"id":1711303090,"firstname":"Patty","lastname":"Wright","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1711303090"},{"id":751267835,"firstname":"Jerod","lastname":"Wright","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=751267835"},{"id":1656712497,"firstname":"Brendan","lastname":"Woods","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1656712497"},{"id":1963717873,"firstname":"RICHARD","lastname":"WOODS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1963717873"},{"id":1754913075,"firstname":"Matthew","lastname":"Woodings","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1754913075"},{"id":566589196,"firstname":"MICHELLE","lastname":"WOODHEAD","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=566589196"},{"id":55184351,"firstname":"PRESTON","lastname":"WOOD","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=55184351"},{"id":812720369,"firstname":"John","lastname":"Womack","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=812720369"},{"id":771424943,"firstname":"Matt","lastname":"Wolff","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=771424943"},{"id":19565344,"firstname":"Amber","lastname":"Witten","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=19565344"},{"id":238636558,"firstname":"MICHAEL","lastname":"WISE","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=238636558"},{"id":2063592928,"firstname":"Leslie","lastname":"Winkle","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2063592928"},{"id":2032410558,"firstname":"TASHA","lastname":"WINEGAR","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2032410558"},{"id":246510517,"firstname":"BRIAN","lastname":"WINEBARGER","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=246510517"},{"id":741918531,"firstname":"MEGHAN","lastname":"WILSON","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=741918531"},{"id":1960468809,"firstname":"Larry","lastname":"Wilson","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1960468809"},{"id":591057388,"firstname":"Greg","lastname":"Wilson","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=591057388"},{"id":1789463277,"firstname":"Kiara","lastname":"Wilson","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1789463277"},{"id":481980810,"firstname":"JASMINE","lastname":"WILLISON","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=481980810"},{"id":1223466249,"firstname":"Tyrone","lastname":"Willingham","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1223466249"},{"id":436554993,"firstname":"John","lastname":"Williamson","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=436554993"},{"id":37347121,"firstname":"OTIS","lastname":"WILLIAMS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=37347121"},{"id":805009739,"firstname":"Adam","lastname":"Williams","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=805009739"},{"id":1177469004,"firstname":"Robert","lastname":"Williams","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1177469004"},{"id":1573489251,"firstname":"Brenda","lastname":"Williams","username":null,"email":"api@schoox.com","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1573489251"},{"id":865130626,"firstname":"Delandre","lastname":"Williams","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=865130626"},{"id":1613189773,"firstname":"BRANDON","lastname":"WILLIAMS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1613189773"},{"id":743829663,"firstname":"Jerome","lastname":"Williams","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=743829663"},{"id":1430509229,"firstname":"TOMMIE","lastname":"WILLIAMS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1430509229"},{"id":1909031620,"firstname":"Malarcha","lastname":"Williams","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1909031620"},{"id":1007609268,"firstname":"Frances","lastname":"Willcox","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1007609268"},{"id":82180,"firstname":"MIKE","lastname":"WILKINS","username":"411.M.WILKINS","email":"api@schoox.com","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=82180"},{"id":671155005,"firstname":"ASHLEY","lastname":"WILKERSON","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=671155005"},{"id":1672953470,"firstname":"Kristin","lastname":"Wilhelm","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1672953470"},{"id":1993761208,"firstname":"Louie","lastname":"Wilhelm","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1993761208"},{"id":137573227,"firstname":"Brittney","lastname":"Wilganowski","username":null,"email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=137573227"},{"id":1354941790,"firstname":"LAUREN","lastname":"WILD","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1354941790"},{"id":1007435927,"firstname":"Jessica","lastname":"Whittaker","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1007435927"},{"id":1206129425,"firstname":"TRISTEN","lastname":"WHITE","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1206129425"},{"id":1093472276,"firstname":"Tommy","lastname":"White","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1093472276"},{"id":1333893272,"firstname":"Danny","lastname":"White","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1333893272"},{"id":1000911018,"firstname":"Snow","lastname":"White","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1000911018"},{"id":1374338536,"firstname":"Kevin","lastname":"White","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1374338536"},{"id":1087146476,"firstname":"JAMES","lastname":"WHITE","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1087146476"},{"id":1697343223,"firstname":"Joey","lastname":"White","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1697343223"},{"id":463767382,"firstname":"Karen","lastname":"Whit","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=463767382"},{"id":1021979883,"firstname":"Lisa","lastname":"Wharton","username":null,"email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1021979883"},{"id":1664094510,"firstname":"Charlie","lastname":"Weis","username":null,"email":"api@schoox.com","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1664094510"},{"id":35044217,"firstname":"Blake","lastname":"Weems","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=35044217"},{"id":1904709930,"firstname":"Tamara","lastname":"Weekes","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1904709930"},{"id":718910138,"firstname":"TAMRA","lastname":"WEBER-ALFARO","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=718910138"},{"id":2082669073,"firstname":"Reese","lastname":"Weathers","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2082669073"},{"id":1452482533,"firstname":"Bruce","lastname":"Wayne","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1452482533"},{"id":1034522001,"firstname":"CHAD","lastname":"WATTS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1034522001"},{"id":429257655,"firstname":"Amanda","lastname":"Watts","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=429257655"},{"id":1785891496,"firstname":"Tom","lastname":"Watson","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1785891496"},{"id":477005242,"firstname":"APRIL","lastname":"WASHBURN\u00c2\u00a0","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=477005242"},{"id":292519872,"firstname":"Amy","lastname":"Washburn","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=292519872"},{"id":290294344,"firstname":"Shahid","lastname":"Waseem","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=290294344"},{"id":1737571618,"firstname":"Fran","lastname":"Warwick","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1737571618"},{"id":1687570975,"firstname":"JOSH","lastname":"WARD","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1687570975"},{"id":1154316285,"firstname":"Casey","lastname":"Ward","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1154316285"},{"id":126476696,"firstname":"Shane","lastname":"Walton","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=126476696"},{"id":128671628,"firstname":"Trey","lastname":"Walter","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=128671628"},{"id":886616518,"firstname":"JOSHUA","lastname":"WALLS","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=886616518"},{"id":1783746420,"firstname":"Lindsay","lastname":"Wallace","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1783746420"},{"id":827921569,"firstname":"TEMPLATE","lastname":"WAITSTAFF","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=827921569"},{"id":125796,"firstname":"Jim","lastname":"Wahlstrom","username":null,"email":"api@schoox.com","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/125796\/egVwUpQUGMAksRE6wCA2_Jim spring 2014(2).jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=125796","roles":["admin"]},{"id":1312106609,"firstname":"Todd","lastname":"Vollrath","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1312106609"},{"id":1469916354,"firstname":"nvfieovnreio","lastname":"vnfiodnviofd","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1469916354"},{"id":410074083,"firstname":"JESUS","lastname":"VIZZUETT","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=410074083"},{"id":733861966,"firstname":"ALFREDO","lastname":"VITAL","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=733861966"},{"id":1878022954,"firstname":"JARRET","lastname":"VINCENT","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1878022954"},{"id":253248,"firstname":"Andres-Manager","lastname":"Villegas","username":null,"email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=253248"},{"id":1075655939,"firstname":"NATALIE","lastname":"VILLASENOR","username":null,"email":"","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1075655939"}]
Get Details of a User
Returns data for a specific user like first and last name, email, role, region, location, job code and his/her current status in the academy.
GET /users/:userid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14?apikey=schoox&acadId=386
Response Object
Show All
{"id":14,"firstname":"Costas","lastname":"Vasiliou","email":"api@schoox.com","external_ids":{"chillis":["7960642"]},"username":"","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/14\/13040840081732309510.jpg","url":"https:\/\/www.schoox.com\/user\/14\/","active":true,"phone":"+16504859192","mobile":"","city":"Austin","country":"Greece","country_code":"GR","state":"tx","address":"8121 Bee Cave Rd","zip":"78746","custom_fields":[],"units":[{"id":30,"name":"Store 100","jobs":[{"id":230,"name":"Cashier"}]}],"above_units":[],"registration_fields":[],"hired_date":null,"roles":["admin","training_manager","professional_instructor"],"certificates":[{"id":16178,"course_id":11657,"ver_code":"d763c80","total_time":0,"time_certified":"2013-02-11T13:12:46+00:00","url":"https:\/\/www.schoox.com\/c16178?ver_code=d763c80"}]}
List User's Badges
Returns a list of user's academy badges.
GET /users/:userid/badges
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/badges?apikey=schoox&acadId=386
Response Object
Show All
[{"id":13,"name":"Great Team Worker","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_great_supporter.png","count":4},{"id":14,"name":"Hard Worker","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_hard_worker.png","count":3},{"id":15,"name":"Great Mentor","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_mentor.png","count":3},{"id":16,"name":"Fellow Helper","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_co-worker_helper.png","count":1},{"id":18,"name":"Great Performance","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_group_member_of_the_month.png","count":3},{"id":77,"name":"Good Answer","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_good_answer.png","count":2},{"id":78,"name":"Good Student","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_good_student.png","count":2},{"id":79,"name":"Good Teacher","image":"https:\/\/www.schoox.com\/badges\/images\/badges\/icon_good_teacher.png","count":3}]
Create & Add a User
Creates and adds a user to the academy. Password is mandatory.
Available user languages:
Afrikaans, Arabic, Armenian, Belarussian, Bulgarian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English, Esperanto, Estonian, Finnish, French, German, Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Korean, Latvian/Lettish, Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovenian, Spanish, Swahili, Swedish, Thai, Turkish, Ukrainian, Vietnamese
POST /users
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/users?apikey=schoox&acadId=386
Request Object
Show All
{"firstname":"BillTest4", "lastname":"Lolos5", "password":"123456", "roles":["employee"],"email":"graecus84@yahoo.gr","above_ids":[18],"unit_ids":[4],"jobs":[{"unit_id":4, "jobs":[2455]},{"above_id":18, "jobs":[1]}], "language":"English"}
Bulk Create & Add Users
Creates and adds multiple users (maximum of 10) to the academy via a single request. Password is mandatory.
POST /users/bulk
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/users/bulk?apikey=schoox&acadId=386
Request Object
Show All
[{"firstname":"BillTest4", "lastname":"Lolos5", "password":"123456", "roles":["employee"],"email":"graecus84@yahoo.gr","above_ids":[18],"unit_ids":[4],"jobs":[{"unit_id":4, "jobs":[2455]},{"above_id":18, "jobs":[1]}], "language":"English"}]
Invite a User
Adds a user through an academy invitation. You can simulate the inviting user by adding his/her schooX ID.
POST /users
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/users?apikey=schoox&acadId=386
Request Object
Show All
{"firstname":"Bill", "lastname":"Lolos", "email":"graecus84@yahoo.gr","roles":["employee"],"above_ids":[1],"unit_ids":[4],"job_ids":[1,4],"external_ids":["ABCDEF"]}
Bulk Invite Users
Adds multiple users through academy invitations via a single request. You can simulate the inviting user by adding his/her schooX ID.
POST /users/bulk
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/users/bulk?apikey=schoox&acadId=386
Request Object
Show All
[{"firstname":"Bill", "lastname":"Lolos", "email":"graecus84@yahoo.gr","roles":["employee"],"above_ids":[1],"unit_ids":[4],"job_ids":[1,4],"external_ids":["ABCDEF"]}]
Edit a User
Edit the firstname, lastname, email or password of a User.
Available user languages:
Afrikaans, Arabic, Armenian, Belarussian, Bulgarian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English, Esperanto, Estonian, Finnish, French, German, Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Korean, Latvian/Lettish, Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovenian, Spanish, Swahili, Swedish, Thai, Turkish, Ukrainian, Vietnamese
PUT /users/:userid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/1234567890?apikey=schoox&acadId=386
Request Object
Show All
{"firstname":"John","lastname":"Doe","email":"johndoe@schoox.com","password":"pwd","external_ids":["ABCDEF"]}
Remove a User
Removes a user from the academy.
DELETE /v1/users/:userid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14?apikey=schoox&acadId=386
Reactivate a User
Reactivates a Past Employee as Employee. You can use the User Id or his/her external_id
POST /users
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/users?apikey=schoox&acadId=386
Request Object
Show All
{"id":"3"}or
Show All
{"external_id":"1001417"}
Add a New Job
Creates a new job. You can also use external_id.
POST /jobs
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/jobs?apikey=schoox&acadId=386
Request Object
Show All
{"name":"API Developer", "report_id": 4945,"external_id":"api"}
Bulk New Jobs
Creates multiple academy jobs via a single request.
POST /jobs/bulk
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/jobs/bulk?apikey=schoox&acadId=386
Request Object
Show All
[{"name":"API Developer"},{"name":"API Evangelist","report_id":5}]
Edit a Job
Changes the name and/or the report id of a job.
PUT /jobs/:jobid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the Job. By default, the value is "false" |
No | String | true |
| title | Sets whether the id given is the current title of the Job. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/jobs/$d?apikey=schoox&acadId=386
Request Object
Show All
{"name":"API Developer"}
Delete a Job
Deletes a specified job. It also removes the job from all assigned users.
DELETE /jobs/:jobid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the Job. By default, the value is "false" |
No | String | true |
| title | Sets whether the id given is the current title of the Job. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/jobs/230?apikey=schoox&acadId=386
List Jobs
Returns a list with all jobs of your Academy.
GET /jobs
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| search | Search by Job title | No | String | Sandwich Artist |
| start | Starting Position | No | Integer | 0 |
| limit | Max items returned per request. Default is 100 | No | Integer | 100 |
Example Request
https://api.schoox.com/v1/jobs?apikey=schoox&acadId=386
Response Object
Show All
[{"id":4975,"name":"Unit Manager","external_id":null,"deletable":false},{"id":4976,"name":"Assistant Unit Manager","external_id":null,"deletable":false},{"id":18894,"name":"Head of Concept","external_id":null,"deletable":false},{"id":24911,"name":"Head of Country","external_id":null,"deletable":false},{"id":173604,"name":"Head of DELETE","external_id":null,"deletable":false},{"id":6504,"name":"Head of Owner","external_id":null,"deletable":false},{"id":4974,"name":"Head of Region","external_id":null,"deletable":false},{"id":55880,"name":"Head of State","external_id":null,"deletable":false},{"id":111454,"name":"*DoNot Use 2","external_id":null,"deletable":true},{"id":111455,"name":"*DoNot Use 4","external_id":null,"deletable":true},{"id":111461,"name":"*DoNot Use 5","external_id":null,"deletable":true},{"id":111398,"name":"*DoNot Use 7","external_id":null,"deletable":true},{"id":111449,"name":"*DoNot Use B","external_id":null,"deletable":true},{"id":111456,"name":"*DoNot Use D","external_id":null,"deletable":true},{"id":111443,"name":"*IAH SUPERVI","external_id":null,"deletable":true},{"id":111476,"name":"ADMINISTRATIVE","external_id":null,"deletable":true},{"id":69584,"name":"APP(RENTICE\/280","external_id":null,"deletable":true},{"id":111402,"name":"ASD EXPO\/208","external_id":null,"deletable":true},{"id":223224,"name":"Assistant Head of Concept","external_id":null,"deletable":false},{"id":223395,"name":"Assistant Head of Country","external_id":null,"deletable":false},{"id":226466,"name":"Assistant Head of DELETE","external_id":null,"deletable":false},{"id":222878,"name":"Assistant Head of Owner","external_id":null,"deletable":false},{"id":222387,"name":"Assistant Head of Region","external_id":null,"deletable":false},{"id":224132,"name":"Assistant Head of State","external_id":null,"deletable":false},{"id":111414,"name":"Banquet","external_id":null,"deletable":true},{"id":19127,"name":"Bar","external_id":null,"deletable":true},{"id":111426,"name":"Bar Back","external_id":null,"deletable":true},{"id":282707,"name":"BARBCK","external_id":null,"deletable":true},{"id":6661,"name":"Bartender","external_id":null,"deletable":true,"report_id":4975},{"id":111492,"name":"BARTENDER\/270","external_id":null,"deletable":true},{"id":111479,"name":"BOH BONUS","external_id":null,"deletable":true},{"id":111477,"name":"BOH MISC\/RETRO PAY","external_id":null,"deletable":true},{"id":111420,"name":"BOH RT\/266","external_id":null,"deletable":true},{"id":111478,"name":"BOH STAR BONUS","external_id":null,"deletable":true},{"id":111487,"name":"BOH TRAINING","external_id":null,"deletable":true},{"id":111430,"name":"BOH TRNG","external_id":null,"deletable":true},{"id":111480,"name":"BOH VACATION","external_id":null,"deletable":true},{"id":69585,"name":"BOOK KEEPERS\\260","external_id":null,"deletable":true},{"id":111472,"name":"Breaker","external_id":null,"deletable":true},{"id":111417,"name":"Bus","external_id":null,"deletable":true},{"id":111484,"name":"BUSPERSON","external_id":null,"deletable":true},{"id":231,"name":"Busser","external_id":null,"deletable":true},{"id":111467,"name":"BUSSER\/206","external_id":null,"deletable":true},{"id":111427,"name":"C19 Kitchen","external_id":null,"deletable":true},{"id":230,"name":"Cashier","external_id":null,"deletable":true},{"id":111394,"name":"Caterer","external_id":null,"deletable":true},{"id":111468,"name":"CELLAR DEWELER\/290","external_id":null,"deletable":true},{"id":111483,"name":"COCKTAIL","external_id":null,"deletable":true},{"id":98121,"name":"COOK","external_id":null,"deletable":true},{"id":111397,"name":"Crew","external_id":null,"deletable":true},{"id":18423,"name":"Crew Member","external_id":null,"deletable":true},{"id":111396,"name":"DISH","external_id":null,"deletable":true},{"id":111418,"name":"DISH WASHER\/240","external_id":null,"deletable":true},{"id":127,"name":"Dishwasher","external_id":null,"deletable":true},{"id":111470,"name":"Doctor","external_id":null,"deletable":true},{"id":3482,"name":"Driver","external_id":null,"deletable":true},{"id":69586,"name":"DRIVER\/220","external_id":null,"deletable":true},{"id":111464,"name":"EXPO\/207","external_id":null,"deletable":true},{"id":111411,"name":"FOH BONUS","external_id":null,"deletable":true},{"id":111406,"name":"FOH MISC\/RETRO PAY","external_id":null,"deletable":true},{"id":111415,"name":"FOH RT 265","external_id":null,"deletable":true},{"id":111407,"name":"FOH STAR BONUS","external_id":null,"deletable":true},{"id":111404,"name":"FOH TRAINEE","external_id":null,"deletable":true},{"id":111493,"name":"FOH TRAINER\/215","external_id":null,"deletable":true},{"id":111463,"name":"FOH TRNG","external_id":null,"deletable":true},{"id":111409,"name":"FOH VACATION","external_id":null,"deletable":true},{"id":111482,"name":"FOOD RUNNER","external_id":null,"deletable":true},{"id":111431,"name":"General Manager","external_id":null,"deletable":true},{"id":111494,"name":"GENERAL MANAGER\/100","external_id":null,"deletable":true},{"id":111412,"name":"HEAD WAIT","external_id":null,"deletable":true},{"id":125,"name":"Host","external_id":null,"deletable":true,"report_id":4975},{"id":111403,"name":"HOST\/210","external_id":null,"deletable":true},{"id":111408,"name":"HOST\/BUS TRAINER","external_id":null,"deletable":true},{"id":111413,"name":"IAH CARI N C","external_id":null,"deletable":true},{"id":111438,"name":"IAH CARI S C","external_id":null,"deletable":true},{"id":111452,"name":"IAH CASHROOM","external_id":null,"deletable":true},{"id":111399,"name":"IAH CNTR BT","external_id":null,"deletable":true},{"id":111432,"name":"IAH COM WDEL","external_id":null,"deletable":true},{"id":111400,"name":"IAH EINS C","external_id":null,"deletable":true},{"id":111436,"name":"IAH LGC BART","external_id":null,"deletable":true},{"id":111459,"name":"IAH LGC COOK","external_id":null,"deletable":true},{"id":111462,"name":"IAH LGC HOST","external_id":null,"deletable":true},{"id":111437,"name":"IAH LGC SERV","external_id":null,"deletable":true},{"id":111446,"name":"IAH PANOP CH","external_id":null,"deletable":true},{"id":111445,"name":"IAH PEETS C","external_id":null,"deletable":true},{"id":111433,"name":"IAH PINTO BT","external_id":null,"deletable":true},{"id":111434,"name":"IAH PINTO CH","external_id":null,"deletable":true},{"id":111444,"name":"IAH TOGO N C","external_id":null,"deletable":true},{"id":111447,"name":"IAH UPPR CSH","external_id":null,"deletable":true},{"id":111448,"name":"IAH UTILITY","external_id":null,"deletable":true},{"id":111457,"name":"Job 1","external_id":null,"deletable":true},{"id":111428,"name":"Job 10","external_id":null,"deletable":true},{"id":111435,"name":"Job 1001","external_id":null,"deletable":true},{"id":111489,"name":"Job 12","external_id":null,"deletable":true},{"id":111460,"name":"Job 4","external_id":null,"deletable":true},{"id":111453,"name":"Job 438705","external_id":null,"deletable":true},{"id":111439,"name":"Job 438707","external_id":null,"deletable":true},{"id":111451,"name":"Job 438711","external_id":null,"deletable":true},{"id":111441,"name":"Job 438712","external_id":null,"deletable":true},{"id":111442,"name":"Job 438723","external_id":null,"deletable":true}]
Update User's Roles
Edit the roles of a given user.
Available roles are:
admin, training_manager, content_manager, professional_instructor, hourly_worker
PUT /users/:userid/roles
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/roles?apikey=schoox&acadId=386
Request Object
Show All
["training_manager", "hourly_worker"]
Update User's Jobs
Edit the jobs of a given user by an array of units/above units & their job Ids. User must be previously assigned to the specified units & above units.
PUT /users/:userid/jobs
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/jobs?apikey=schoox&acadId=386
Request Object
Show All
[{"unit":2002, "jobs":[7160]},{"above_unit":636, "jobs":[7158, 7156]}]
Add Units to a User
Adds Units to a given User by an array of Unit Ids.
PUT /users/:userid/units
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| title | Sets whether the ids given are the titles of the Units. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/units?apikey=schoox&acadId=386
Request Object
Show All
[4]
Remove Unit from a User
Removes a Unit from a given User
DELETE /users/:userid/units/:unitid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| title | Sets whether the ids given are the titles of the Units. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/units/35?apikey=schoox&acadId=386
Add Above Units to a User
Adds Aboves Units to a given User by an array of Above Unit Ids.
PUT /users/:userid/aboves
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| title | Sets whether the ids given are the titles of the Above Units. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/aboves?apikey=schoox&acadId=386
Request Object
Show All
[11,12]
Remove Above Unit from a User
Removes an Above Unit from a given User
DELETE /users/:userid/aboves/:aboveid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| title | Sets whether the ids given are the titles of the Above Units. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/users/14/aboves/35?apikey=schoox&acadId=386
Add a New Type
Creates a new Type.
POST /types
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/types?apikey=schoox&acadId=386
Request Object
Show All
{"name":"Region"}
Bulk New Types
Creates multiple Types via a single request.
POST /types/bulk
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/types/bulk?apikey=schoox&acadId=386
Request Object
Show All
[{"name":"Region"}, {"name":"Contract"}]
Edit a Type
Changes the name of a Type.
PUT /types/:typeid
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/types/0?apikey=schoox&acadId=386
Request Object
Show All
{"name":"Region"}
Delete a Type
Deletes a specified type.
DELETE /types/:typeid
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/types/0?apikey=schoox&acadId=386
List Types
Returns a list of all Types of your Academy.
GET /types
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/types?apikey=schoox&acadId=386
Response Object
Show All
[{"id":1630,"name":"Concept"},{"id":2038,"name":"Country"},{"id":11953,"name":"DELETE"},{"id":612,"name":"Owner"},{"id":101,"name":"Region"},{"id":3400,"name":"State"}]
Add a New Above Unit
Creates a new Above Unit and connects it to a Type.
POST /aboves
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/aboves?apikey=schoox&acadId=386
Request Object
Show All
{"name":"Greece", "type_id":6}
Bulk New Above Units
Creates multiple Above Units (maximum of 100) via a single request.
POST /aboves/bulk
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/aboves/bulk?apikey=schoox&acadId=386
Request Object
Show All
[{"name":"Greece", "type_id":6}, {"name":"US", "type_id":6}]
Edit an Above Unit
Changes the name and/or the type of an Above Unit.
PUT /aboves/:aboveid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Above Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/aboves/20?apikey=schoox&acadId=386
Request Object
Show All
{"name":"United States"}
Delete an Above Unit
Deletes a specific Above Unit.
DELETE /aboves/:aboveid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Above Unit. By default, the value is "false" |
No | String | true |
| external_id | Sets whether the id given is the external_id of the Above Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/aboves/20?apikey=schoox&acadId=386
List Above Units
Returns a list of Above Units (max. 100/request) of your Academy.
GET /aboves
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| type_id | Filter Above Units by Type ID | No | Integer | 0 |
| search | Search by Above Unit title | No | String | Greece |
| start | Starting Position | No | Integer | 0 |
| limit | Number of Above Units to return per request, up to maximum of 100,000. Default to 100 | No | Integer | 100 |
Example Request
https://api.schoox.com/v1/aboves?apikey=schoox&acadId=386
Response Object
Show All
[{"id":1770,"name":"Great Food","type_id":1630,"external_id":null,"parent_id":300},{"id":230358,"name":"Not So Great Food","type_id":1630,"external_id":"45","parent_id":300},{"id":5328,"name":"USA","type_id":2038,"external_id":null,"parent_id":0},{"id":340180,"name":"All Owners","type_id":612,"external_id":null,"parent_id":0},{"id":300,"name":"Bob Smith","type_id":612,"external_id":null,"parent_id":340180},{"id":319957,"name":"John Albee","type_id":612,"external_id":null,"parent_id":340180},{"id":1496,"name":"Lisa Edwards","type_id":612,"external_id":null,"parent_id":340180},{"id":1499,"name":"Terry Jones","type_id":612,"external_id":null,"parent_id":340180},{"id":25,"name":"California","type_id":101,"external_id":null,"parent_id":0},{"id":22,"name":"New York","type_id":101,"external_id":null,"parent_id":0},{"id":252,"name":"Texas","type_id":101,"external_id":null,"parent_id":0}]
Add a New Unit
Creates a new Unit and connects it to Above Units, via an array of Above Unit ids (above_ids) or an array of Above Unit names (above_names).
POST /units
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/units?apikey=schoox&acadId=386
Request Object
Show All
{"name":"Austin", "above_ids": [109], "external_id": "AUSTIN.TX"}
Bulk New Units
Creates multiple Units (maximum of 100) via a single request.
POST /units/bulk
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/units/bulk?apikey=schoox&acadId=386
Request Object
Show All
[{"name":"Austin", "above_ids": [109], "external_id": "AUSTIN.TX"},{"name":"Atlanta", "above_ids": [85]}]
Edit a Unit
Changes the name and/or the above units of a Unit.
PUT /units/:unitid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Unit. By default, the value is "false" |
No | String | true |
| external_id | Sets whether the id given is the external_id of the Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/units/35?apikey=schoox&acadId=386
Request Object
Show All
{"name":"Austin, TX", "above_ids":[110], "external_id": "AUSTIN.TX"}
Delete a Unit
Deletes a specific Unit.
DELETE /units/:unitid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Unit. By default, the value is "false" |
No | String | true |
| external_id | Sets whether the id given is the external_id of the Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/units/35?apikey=schoox&acadId=386
List Units
Returns a list of Units of your Academy.
GET /units
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| search | Search by Unit title. Comma separate for multiple search terms |
No | String | Store #3506 |
| search_above | Filter by Above Unit title | No | String | Greece |
| above_id | Filter Units by an Above Unit Id | No | Integer | 2105 |
| start | List's starting position | No | Integer | 0 |
| limit | Number of Units to return per request, up to maximum of 100,000. Default to 100 |
No | Integer | 100 |
Example Request
https://api.schoox.com/v1/units?apikey=schoox&acadId=386
Response Object
Show All
[{"id":284940,"name":"Approved Time Off Demo","external_id":null,"above_ids":[]},{"id":284946,"name":"Bob","external_id":null,"above_ids":[]},{"id":284945,"name":"Carinos Preload Test","external_id":null,"above_ids":[]},{"id":241861,"name":"Dinosaurs Like Training","external_id":null,"above_ids":[]},{"id":249778,"name":"HotSchedules - Demo","external_id":null,"above_ids":[]},{"id":284947,"name":"HotSchedules - Demo LB","external_id":null,"above_ids":[]},{"id":239481,"name":"HotSchedules - Online Training","external_id":null,"above_ids":[]},{"id":284941,"name":"HotSchedules - Product Training","external_id":null,"above_ids":[]},{"id":239210,"name":"HotSchedules - QA","external_id":null,"above_ids":[]},{"id":284942,"name":"HS Demo","external_id":null,"above_ids":[]},{"id":241860,"name":"HS Online Training","external_id":null,"above_ids":[]},{"id":284948,"name":"HS Training","external_id":null,"above_ids":[]},{"id":241862,"name":"Mellie's Test Site","external_id":null,"above_ids":[]},{"id":284949,"name":"Neil","external_id":null,"above_ids":[]},{"id":284939,"name":"SSP America Lab","external_id":null,"above_ids":[]},{"id":30,"name":"Store 100","external_id":null,"above_ids":[{"id":300,"name":"Bob Smith","type":"Owner"},{"id":252,"name":"Texas","type":"Region"},{"id":5328,"name":"USA","type":"Country"}]},{"id":31,"name":"Store 200","external_id":null,"above_ids":[{"id":300,"name":"Bob Smith","type":"Owner"},{"id":1496,"name":"Lisa Edwards","type":"Owner"},{"id":252,"name":"Texas","type":"Region"},{"id":5328,"name":"USA","type":"Country"}]},{"id":32,"name":"Store 300","external_id":null,"above_ids":[{"id":22,"name":"New York","type":"Region"},{"id":1499,"name":"Terry Jones","type":"Owner"},{"id":5328,"name":"USA","type":"Country"}]},{"id":6353,"name":"Store 400","external_id":null,"above_ids":[{"id":25,"name":"California","type":"Region"},{"id":5328,"name":"USA","type":"Country"}]},{"id":6354,"name":"Store 500","external_id":null,"above_ids":[{"id":25,"name":"California","type":"Region"},{"id":1496,"name":"Lisa Edwards","type":"Owner"},{"id":5328,"name":"USA","type":"Country"}]},{"id":284944,"name":"Survey English","external_id":null,"above_ids":[]},{"id":284943,"name":"xxxMaggiano's - The Domain","external_id":null,"above_ids":[]}]
Archive a Unit
Archive a Unit.
PUT /units/:unitid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/units/35?apikey=schoox&acadId=386
Request Object
Show All
{"archive":true}
Unarchive a Unit
Unarchive a Unit.
PUT /units/archived/:unitid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/units/archived/35?apikey=schoox&acadId=386
Request Object
Show All
{"archive":false}
Delete an Archived Unit
Deletes a specific Archived Unit.
DELETE /units/archived/:unitid
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| title | Sets whether the id given is the current title of the Unit. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/units/archived/35?apikey=schoox&acadId=386
List Archived Units
Returns a list of Archived Units of your Academy.
GET /units/archived
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| search | Search by Unit title | No | String | Store #3506 |
| search_above | Filter by Above Unit title | No | String | Greece |
| above_id | Filter Units by an Above Unit Id | No | Integer | 2105 |
| start | List's starting position | No | Integer | 0 |
| limit | Number of Units to return per page, up to maximum of 10,000. Default to 100 | No | Integer | 100 |
Example Request
https://api.schoox.com/v1/units/archived?apikey=schoox&acadId=386
Response Object
Show All
No demo data available
Assign Courses
Assigns one or more courses (max. 10/request) to a user.
PUT /users/:userid/courses
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/users/:userid/courses?apikey=schoox&acadId=386
Request Object
Show All
{"courses":[1,2,3]}