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
- Courses
- List of Courses
- List of a User's Courses
- List of a User's Course Categories
- Details for a Course
- List of Enrolled Users in a Course
- List of Lectures in a Course
- List of Exams in a Course
- List of Coupons in a Course
- List of Enrolled Users in a Course Coupon
- List of all Course Invitations
- List of skills related to course
- Course complete by admin
- 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
- Unassign Courses
- Assign Curricula
- Unassign Curricula
- Add/Edit lecture progress for a user
- Check whether users are registered in a future Event
- Metrics
- Metrics
- List of Metrics
- Add Metrics
- Group Metrics
- Edit a Metrics Group
- Delete a Metrics Group
- Edit a Metric
- Delete a Metric
- Connect a Metric to a Job
- Connect a Metric to a Course
- Connect a Group of Metrics to a Job
- Connect a Group of Metrics to a Course
- Assess a Job Metrics for a User
- Assess a Metric for a User
- Ungroup a Metric
- Unlink a Metric from a Course
- Unlink a Metric from a Job
- Badges
- Content
- API usage
- Groups
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":1918259581,"firstname":"Andre","lastname":"3000","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1918259581","modified_at":"2017-04-17 08:58:24","username":null,"external_ids":[]},{"id":1926903142,"firstname":"Agent","lastname":"47","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1926903142","modified_at":"2019-06-01 20:24:10","username":null,"external_ids":[]},{"id":1881544869,"firstname":"a","lastname":"a","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1881544869","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":829937839,"firstname":"Kendra","lastname":"AAAEmployee","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=829937839","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1164460590,"firstname":"HEATHER","lastname":"AAEmployee","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1164460590","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1667513535,"firstname":"BRENDA","lastname":"ABENSUR","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1667513535","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":538781690,"firstname":"Albert","lastname":"Ackers","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=538781690","modified_at":"2018-03-15 01:20:19","username":null,"external_ids":[]},{"id":5568246,"firstname":"Scott","lastname":"Adams","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=5568246","modified_at":"2021-06-03 14:55:26","username":null,"external_ids":[]},{"id":1095644512,"firstname":"Thomas","lastname":"Adams","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1095644512","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":562455280,"firstname":"Travis","lastname":"Adams","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=562455280","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1520649482,"firstname":"Melanie","lastname":"AdamsASC","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1520649482","modified_at":"2019-06-01 20:24:23","username":null,"external_ids":[]},{"id":1513985128,"firstname":"DAVID","lastname":"AGUILAR","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1513985128","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1534354124,"firstname":"Ruth","lastname":"Aguilar","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1534354124","modified_at":"2019-06-01 20:24:38","username":null,"external_ids":[]},{"id":1513723349,"firstname":"PHILIP","lastname":"AHN","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1513723349","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":11925,"firstname":"John","lastname":"Alaister","email":"[email protected]","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/11925\/13530717721409572663.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=11925","modified_at":"2019-01-07 09:14:56","username":"","external_ids":[]},{"id":13889703,"firstname":"Kyle","lastname":"Albright","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13889703","modified_at":"2021-06-03 14:55:17","username":null,"external_ids":[]},{"id":1455409033,"firstname":"Lily","lastname":"Aldrin","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1455409033","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1438529665,"firstname":"NIKKI","lastname":"ALEXANDER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1438529665","modified_at":"2021-06-09 12:18:02","username":null,"external_ids":[]},{"id":134506756,"firstname":"JESSE","lastname":"ALLEN","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=134506756","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1716983215,"firstname":"Shepherd","lastname":"Allen","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1716983215","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":2055709105,"firstname":"Robert","lastname":"Allison","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2055709105","modified_at":"2019-06-01 20:24:20","username":null,"external_ids":[]},{"id":1792950202,"firstname":"COLLEEN","lastname":"ALMY","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1792950202","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":609953032,"firstname":"goh","lastname":"aloysius","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=609953032","modified_at":"2021-10-14 09:03:14","username":null,"external_ids":[]},{"id":711604399,"firstname":"Linda","lastname":"Alsworth","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=711604399","modified_at":"2019-06-01 20:24:16","username":null,"external_ids":[]},{"id":28184631,"firstname":"Cindy","lastname":"Alton","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=28184631","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1699274776,"firstname":"Jose","lastname":"Alvarado","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1699274776","modified_at":"2019-06-01 20:24:13","username":null,"external_ids":[]},{"id":731175446,"firstname":"William","lastname":"Aman","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=731175446","modified_at":"2019-06-01 20:24:11","username":null,"external_ids":[]},{"id":1916958152,"firstname":"JOSE","lastname":"AMAYA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1916958152","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":416821766,"firstname":"AMDELIVERY","lastname":"AMDELIVERY","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=416821766","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1353012007,"firstname":"Heidi","lastname":"Ampres","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1353012007","modified_at":"2018-03-15 01:20:21","username":null,"external_ids":[]},{"id":674735732,"firstname":"Eddy","lastname":"Amrieh","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=674735732","modified_at":"2019-06-01 20:24:09","username":null,"external_ids":[]},{"id":623663250,"firstname":"STEPHEN","lastname":"AMUNDSON","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=623663250","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":810175310,"firstname":"Mary","lastname":"Anderson","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=810175310","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":957274300,"firstname":"Michelle","lastname":"Anderson","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=957274300","modified_at":"2021-06-03 14:55:26","username":null,"external_ids":[]},{"id":957971170,"firstname":"Sharlita","lastname":"Anderson","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=957971170","modified_at":"2019-06-01 20:24:43","username":null,"external_ids":[]},{"id":722730183,"firstname":"Stacey","lastname":"Anderson","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=722730183","modified_at":"2017-04-17 08:58:23","username":null,"external_ids":[]},{"id":770137922,"firstname":"OSCAR","lastname":"ANDINO","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=770137922","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":267821164,"firstname":"Jennifer","lastname":"Aniston","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=267821164","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":310957589,"firstname":"Alamjeh","lastname":"Antrose","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=310957589","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1037352271,"firstname":"Ima","lastname":"Appleuser","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1037352271","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":698799039,"firstname":"HUMBERTO","lastname":"AQUIN","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=698799039","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1854221617,"firstname":"Brandon","lastname":"Arino","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1854221617","modified_at":"2017-02-16 12:40:04","username":null,"external_ids":[]},{"id":13733193,"firstname":"Roxanne","lastname":"Arneson","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13733193","modified_at":"2020-04-20 14:10:50","username":"","external_ids":[]},{"id":2035805883,"firstname":"Dane","lastname":"Arnold","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2035805883","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1146047113,"firstname":"CHANTIS","lastname":"ARRINGTON","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1146047113","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1848820339,"firstname":"EYAD","lastname":"ASAD","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1848820339","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1046735068,"firstname":"Aaron","lastname":"ASC","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1046735068","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":316492613,"firstname":"asdf","lastname":"asdf","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=316492613","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1168298609,"firstname":"asdf","lastname":"asf","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1168298609","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1252395867,"firstname":"Danielle","lastname":"Ashford","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1252395867","modified_at":"2019-06-01 20:24:15","username":null,"external_ids":[]},{"id":151387,"firstname":"RANDALL","lastname":"ASHFORD","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=151387","modified_at":"2020-12-14 10:14:31","username":null,"external_ids":[]},{"id":279581143,"firstname":"Mary","lastname":"Asmore","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=279581143","modified_at":"2019-06-01 20:24:32","username":null,"external_ids":[]},{"id":1306758308,"firstname":"Ranada","lastname":"Asmore","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1306758308","modified_at":"2019-06-01 20:24:34","username":null,"external_ids":[]},{"id":1802989904,"firstname":"Freddie","lastname":"Astaire","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1802989904","modified_at":"2017-02-16 12:40:27","username":null,"external_ids":[]},{"id":1884403014,"firstname":"William","lastname":"Austin Jr","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1884403014","modified_at":"2019-06-01 20:24:13","username":null,"external_ids":[]},{"id":504203489,"firstname":"BARBIE","lastname":"AVILA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=504203489","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1752107084,"firstname":"MARCO 70","lastname":"AVILA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1752107084","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1517694569,"firstname":"ARSI","lastname":"AVIN","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1517694569","modified_at":"2019-06-01 20:24:40","username":null,"external_ids":[]},{"id":591374862,"firstname":"JOHNATHAN","lastname":"AYALA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=591374862","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":386882546,"firstname":"JONATHAN","lastname":"AYALA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=386882546","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":743278182,"firstname":"Laura","lastname":"Azar","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=743278182","modified_at":"2019-06-01 20:24:23","username":null,"external_ids":[]},{"id":634773842,"firstname":"LINDSAY","lastname":"BACC","email":null,"image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=634773842","modified_at":"2017-02-16 12:40:03","username":null,"external_ids":[]},{"id":1636656923,"firstname":"Alicia","lastname":"Bachert","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1636656923","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":534714033,"firstname":"SHANE","lastname":"BADER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=534714033","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":13317,"firstname":"Manuel","lastname":"Bahs","email":"[email protected]","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13317\/13614612421039648534.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13317","modified_at":"2017-04-17 08:58:31","username":null,"external_ids":[]},{"id":1772027458,"firstname":"JESSICA","lastname":"BAILEY","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1772027458","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":12838,"firstname":"Aaron","lastname":"Baker","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=12838","modified_at":"2020-04-10 16:28:22","username":null,"external_ids":[]},{"id":1703486386,"firstname":"Aaron","lastname":"Baker","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1703486386","modified_at":"2019-06-01 20:24:21","username":null,"external_ids":[]},{"id":1622266664,"firstname":"Donna","lastname":"Baker","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1622266664","modified_at":"2021-06-03 14:55:23","username":null,"external_ids":[]},{"id":1152669863,"firstname":"Dusty","lastname":"Baker","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1152669863","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1323260485,"firstname":"Britney","lastname":"Banks","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1323260485","modified_at":"2019-06-01 20:24:24","username":null,"external_ids":[]},{"id":714951450,"firstname":"Marion","lastname":"Barber","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=714951450","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":684696987,"firstname":"RICHARD","lastname":"BARBERENA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=684696987","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":641375714,"firstname":"SANDRA","lastname":"BARBERENA","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=641375714","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1553349196,"firstname":"RACHEL","lastname":"BARKER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1553349196","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1744756456,"firstname":"Greg","lastname":"Barnes","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1744756456","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":12824,"firstname":"Raechel","lastname":"Barnes","email":"[email protected]","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/12824\/pnXkKq6eSuGRt6QRecpb_Gav and Mommy_Monarch Pass_May 2013.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=12824","modified_at":"2019-09-18 14:05:46","username":"","external_ids":[]},{"id":359059706,"firstname":"Jorge","lastname":"Barrientos","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=359059706","modified_at":"2019-06-01 20:24:37","username":null,"external_ids":[]},{"id":2055696035,"firstname":"Rosa","lastname":"Barron","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2055696035","modified_at":"2019-06-01 20:24:15","username":null,"external_ids":[]},{"id":377166809,"firstname":"Monica","lastname":"Bartlett","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=377166809","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1353381201,"firstname":"Kelly","lastname":"Barton","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1353381201","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":880364495,"firstname":"Felicia","lastname":"Bass","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=880364495","modified_at":"2019-06-01 20:24:43","username":null,"external_ids":[]},{"id":1048633671,"firstname":"Mirian","lastname":"Batres","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1048633671","modified_at":"2019-06-01 20:24:19","username":null,"external_ids":[]},{"id":2107893464,"firstname":"DUSTY","lastname":"BAUER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2107893464","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1719667197,"firstname":"Brittany","lastname":"Baugh","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1719667197","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1248745472,"firstname":"Tristyn","lastname":"Bautista","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1248745472","modified_at":"2019-06-01 20:24:26","username":null,"external_ids":[]},{"id":1987833895,"firstname":"CASEY","lastname":"BAXTER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1987833895","modified_at":"2021-05-29 13:35:59","username":null,"external_ids":[]},{"id":517685120,"firstname":"Courtney","lastname":"Baylor","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=517685120","modified_at":"2019-06-01 20:24:28","username":null,"external_ids":[]},{"id":922761293,"firstname":"Josh","lastname":"Beacom","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=922761293","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":660448868,"firstname":"Katima","lastname":"Beaver","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=660448868","modified_at":"2019-06-01 20:24:27","username":null,"external_ids":[]},{"id":1684497160,"firstname":"Issac","lastname":"Becerra","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1684497160","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1354294907,"firstname":"CASEY","lastname":"BECKER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1354294907","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":2029191516,"firstname":"Pam","lastname":"Beesly","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=2029191516","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":142613152,"firstname":"STEVEN","lastname":"BEGNAUD","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=142613152","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1016602881,"firstname":"Thomas","lastname":"Bell","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1016602881","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":723686510,"firstname":"Mia","lastname":"Bella","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=723686510","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":917750084,"firstname":"DANIEL","lastname":"BELTER","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=917750084","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]},{"id":1221534049,"firstname":"Anna","lastname":"Belton","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1221534049","modified_at":"2017-02-16 12:40:12","username":null,"external_ids":[]},{"id":1013414734,"firstname":"ADRIAN","lastname":"BELTRAN","email":"[email protected]","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1013414734","modified_at":"2019-08-06 15:37:26","username":null,"external_ids":[]},{"id":1242611016,"firstname":"ALEJANDRO","lastname":"BELTRAN","email":"","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=1242611016","modified_at":"2018-09-10 09:58:20","username":null,"external_ids":[]}]
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
User is not connected with the academy
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
User is not connected with the academy
Create & Add a User
Creates and adds a user to the academy. Password is a mandatory field in order to create a user. If it is omitted, the user will be added through an academy invitation. Email, username or an external id are mandatory fields.
In case the Academy has User custom fields created, the call can contain values for these fields as shown in the example Request Object below.
Password must be at least 8 characters, maximum 64 characters, and contain at least 1 uppercase and 1 lowercase letter. Name, username or email shouldn't be part of the password and it can't contain more than 3 identical characters.
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":"jRJqPVPHZYSeDXPU", "roles":["employee"],"email":"[email protected]","above_ids":[18],"unit_ids":[4],"jobs":[{"unit_id":4, "jobs":[2455]},{"above_id":18, "jobs":[1]}], "language":"English", "hired_date":"2006-08-11", "middlename":"J.", "employee_type":"Manager", "employee_number":"AurW323", "custom_fields":[{"custom_field_1":"Custom Value 1"},{"custom_field_2":"Custom Value 2"}]}
Bulk Create & Add Users
Creates and adds multiple users (maximum of 10) to the academy via a single request. Password is mandatory.
Password must be at least 8 characters, maximum 64 characters, and contain at least 1 uppercase and 1 lowercase letter. Name, username or email shouldn't be part of the password and it can't contain more than 3 identical characters.
In case the Academy has User custom fields created, the call can contain values for these fields as shown in the example Request Object below.
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":"jRJqPVPHZYSeDXPU", "roles":["employee"],"email":"[email protected]","above_ids":[18],"unit_ids":[4],"jobs":[{"unit_id":4, "jobs":[2455]},{"above_id":18, "jobs":[1]}], "language":"English", "custom_fields":[{"custom_field_1":"Custom Value 1"},{"custom_field_2":"Custom Value 2"}]}]
Invite a User
Adds a user through an academy invitation. An email is mandatory. 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":"[email protected]","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":"[email protected]","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.
In case the Academy has User custom fields created, the call can contain values for these fields as shown in the example Request Object below.
Password must be at least 8 characters, maximum 64 characters, and contain at least 1 uppercase and 1 lowercase letter. Name, username or email shouldn't be part of the password and it can't contain more than 3 identical characters.
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":"[email protected]","password":"jRJqPVPHZYSeDXPU","external_ids":["ABCDEF"], "custom_fields":[{"custom_field_1":"Custom Value 1"},{"custom_field_2":"Custom Value 2"}]}
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":612963,"name":"Best Location","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":564235,"name":"Coverage","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":458299,"name":"Dino Guide","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":"J00002434","deletable":true},{"id":69586,"name":"DRIVER\/220","external_id":null,"deletable":true},{"id":564236,"name":"Expo","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":563684,"name":"Forkmeister","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":564234,"name":"Greeter","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}]
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.
You can connect the above unit to a parent above unit by adding a parent_id value.
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, "external_id": "GR","parent_id":4}
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.
You can connect or change the above unit's parent above unit by adding a parent_id value.
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","parent_id":5}
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,"parent_external_id":null},{"id":230358,"name":"Not So Great Food","type_id":1630,"external_id":"45","parent_id":300,"parent_external_id":null},{"id":5328,"name":"USA","type_id":2038,"external_id":null,"parent_id":0,"parent_external_id":null},{"id":340180,"name":"All Owners","type_id":612,"external_id":null,"parent_id":0,"parent_external_id":null},{"id":300,"name":"Bob Smith","type_id":612,"external_id":null,"parent_id":340180,"parent_external_id":null},{"id":319957,"name":"John Albee","type_id":612,"external_id":null,"parent_id":340180,"parent_external_id":null},{"id":1496,"name":"Lisa Edwards","type_id":612,"external_id":null,"parent_id":340180,"parent_external_id":null},{"id":1499,"name":"Terry Jones","type_id":612,"external_id":null,"parent_id":340180,"parent_external_id":null},{"id":25,"name":"California","type_id":101,"external_id":null,"parent_id":0,"parent_external_id":null},{"id":22,"name":"New York","type_id":101,"external_id":null,"parent_id":0,"parent_external_id":null},{"id":252,"name":"Texas","type_id":101,"external_id":null,"parent_id":0,"parent_external_id":null}]
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 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 |
| 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/:userid/courses?apikey=schoox&acadId=386
Request Object
Show All
{"courses":[1,2,3],"dueDays":2,"message":"Sample message"}
Unassign Courses
Unassigns one or more courses (max. 10/request) from a user.
PUT /users/:userid/courses_unassign
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/:userid/courses_unassign?apikey=schoox&acadId=386
Request Object
Show All
{"courses":[1,2,3]}
Assign Curricula
Assigns one or more curricula (max. 10/request) to a user.
PUT /users/:userid/curricula
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/:userid/curricula?apikey=schoox&acadId=386
Request Object
Show All
{"curricula":[1,2,3],"dueDays":2,"message":"Sample message"}
Unassign Curricula
Unassigns one or more curricula (max. 10/request) from a user.
PUT /users/:userid/curricula_unassign
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/:userid/curricula_unassign?apikey=schoox&acadId=386
Request Object
Show All
{"curricula":[1,2,3]}
Add/Edit lecture progress for a user
Adds/Edits lecture progress for a user (max. 10/request).
PUT /users/:userid/lectures
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/:userid/lectures?apikey=schoox&acadId=386
Request Object
Show All
{"course_id":25,"lectures":[{"id":40,"progress":100,"total_time":11},{"id":41,"total_time":22,"progress":100}]}
Check whether users are registered in a future Event
Checks whether users (max. 10/request) are registered in a future Event
GET /users/0/events
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| userIds | Array of user ids | No | Array | [1,2,3,4] |
Example Request
https://api.schoox.com/v1/users/0/events?userIds=[1,2,3,4]&apikey=schoox&acadId=386
Response Object
Show All
[{"user":"User not member of the academy","hasFutureEvent":false},{"user":"User not member of the academy","hasFutureEvent":false},{"user":"User not member of the academy","hasFutureEvent":false},{"user":"User not member of the academy","hasFutureEvent":false}]