API Documentation

Training Dashboard

The following requests relate to getting information about users' training performance from different points of view 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 current users in your organization with a summary of their training performance (e.g. total training hours, courses and exams). By default only the first 100 people are returned. The list can be filtered on letter, role, region and location and paged using the optional paging parameters.

GET /dashboard/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 Users' role Yes String employee
external_id Sets whether the id given is the external_id of the User.
By default, the value is "false"
No String true
aboveId Above Unit's ID No Integer 1
unitId Unit's ID No Integer 4
jobId Job's ID No Integer 7
search Search text No String John Doe
start List's starting position No Integer 0
limit Number of users to return per request, up to maximum of 1,000. Default to 100 No Integer 100
sort Sorting criteria No String lastname
order Descending or ascending order No String DESC
Example Request

https://api.schoox.com/v1/dashboard/users?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":1918259581,"firstname":"Andre","lastname":"3000","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1918259581\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1926903142,"firstname":"Agent","lastname":"47","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1926903142\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1881544869,"firstname":"a","lastname":"a","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1881544869\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":829937839,"firstname":"Kendra","lastname":"AAAEmployee","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/829937839\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1164460590,"firstname":"HEATHER","lastname":"AAEmployee","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1164460590\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1667513535,"firstname":"BRENDA","lastname":"ABENSUR","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1667513535\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":538781690,"firstname":"Albert","lastname":"Ackers","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/538781690\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":5568246,"firstname":"Scott","lastname":"Adams","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/5568246\/","total_course_hours":"0:00:00","total_courses":1,"total_exams":0},{"id":1095644512,"firstname":"Thomas","lastname":"Adams","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1095644512\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":562455280,"firstname":"Travis","lastname":"Adams","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/562455280\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1520649482,"firstname":"Melanie","lastname":"AdamsASC","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1520649482\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1513985128,"firstname":"DAVID","lastname":"AGUILAR","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1513985128\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1534354124,"firstname":"Ruth","lastname":"Aguilar","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1534354124\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1513723349,"firstname":"PHILIP","lastname":"AHN","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1513723349\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":11925,"firstname":"John","lastname":"Alaister","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/11925\/13530717721409572663.jpg","url":"https:\/\/www.schoox.com\/user\/11925\/","total_course_hours":"2:16:26","total_courses":11,"total_exams":0},{"id":13889703,"firstname":"Kyle","lastname":"Albright","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/13889703\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1455409033,"firstname":"Lily","lastname":"Aldrin","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1455409033\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1438529665,"firstname":"NIKKI","lastname":"ALEXANDER","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1438529665\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":134506756,"firstname":"JESSE","lastname":"ALLEN","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/134506756\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1716983215,"firstname":"Shepherd","lastname":"Allen","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1716983215\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":2055709105,"firstname":"Robert","lastname":"Allison","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2055709105\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1792950202,"firstname":"COLLEEN","lastname":"ALMY","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1792950202\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":711604399,"firstname":"Linda","lastname":"Alsworth","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/711604399\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":28184631,"firstname":"Cindy","lastname":"Alton","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/28184631\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1699274776,"firstname":"Jose","lastname":"Alvarado","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1699274776\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":731175446,"firstname":"William","lastname":"Aman","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/731175446\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1916958152,"firstname":"JOSE","lastname":"AMAYA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1916958152\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":416821766,"firstname":"AMDELIVERY","lastname":"AMDELIVERY","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/416821766\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1353012007,"firstname":"Heidi","lastname":"Ampres","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1353012007\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":674735732,"firstname":"Eddy","lastname":"Amrieh","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/674735732\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":623663250,"firstname":"STEPHEN","lastname":"AMUNDSON","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/623663250\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":810175310,"firstname":"Mary","lastname":"Anderson","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/810175310\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":957274300,"firstname":"Michelle","lastname":"Anderson","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/957274300\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":957971170,"firstname":"Sharlita","lastname":"Anderson","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/957971170\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":722730183,"firstname":"Stacey","lastname":"Anderson","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/722730183\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":770137922,"firstname":"OSCAR","lastname":"ANDINO","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/770137922\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":267821164,"firstname":"Jennifer","lastname":"Aniston","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/267821164\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":310957589,"firstname":"Alamjeh","lastname":"Antrose","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/310957589\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1037352271,"firstname":"Ima","lastname":"Appleuser","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1037352271\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":698799039,"firstname":"HUMBERTO","lastname":"AQUIN","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/698799039\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1854221617,"firstname":"Brandon","lastname":"Arino","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1854221617\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":13733193,"firstname":"Roxanne","lastname":"Arneson","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/13733193\/","total_course_hours":"0:00:00","total_courses":1,"total_exams":0},{"id":2035805883,"firstname":"Dane","lastname":"Arnold","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2035805883\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1146047113,"firstname":"CHANTIS","lastname":"ARRINGTON","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1146047113\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1848820339,"firstname":"EYAD","lastname":"ASAD","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1848820339\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1046735068,"firstname":"Aaron","lastname":"ASC","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1046735068\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":316492613,"firstname":"asdf","lastname":"asdf","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/316492613\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1168298609,"firstname":"asdf","lastname":"asf","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1168298609\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1252395867,"firstname":"Danielle","lastname":"Ashford","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1252395867\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":151387,"firstname":"RANDALL","lastname":"ASHFORD","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/151387\/","total_course_hours":"0:00:00","total_courses":4,"total_exams":0},{"id":279581143,"firstname":"Mary","lastname":"Asmore","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/279581143\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1306758308,"firstname":"Ranada","lastname":"Asmore","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1306758308\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1802989904,"firstname":"Freddie","lastname":"Astaire","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1802989904\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1884403014,"firstname":"William","lastname":"Austin Jr","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1884403014\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":504203489,"firstname":"BARBIE","lastname":"AVILA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/504203489\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1752107084,"firstname":"MARCO 70","lastname":"AVILA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1752107084\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1517694569,"firstname":"ARSI","lastname":"AVIN","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1517694569\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":591374862,"firstname":"JOHNATHAN","lastname":"AYALA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/591374862\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":386882546,"firstname":"JONATHAN","lastname":"AYALA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/386882546\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":743278182,"firstname":"Laura","lastname":"Azar","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/743278182\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":634773842,"firstname":"LINDSAY","lastname":"BACC","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/634773842\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1636656923,"firstname":"Alicia","lastname":"Bachert","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1636656923\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":534714033,"firstname":"SHANE","lastname":"BADER","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/534714033\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":13317,"firstname":"Manuel","lastname":"Bahs","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13317\/13614612421039648534.jpg","url":"https:\/\/www.schoox.com\/user\/13317\/","total_course_hours":"0:07:19","total_courses":5,"total_exams":0},{"id":1772027458,"firstname":"JESSICA","lastname":"BAILEY","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1772027458\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":12838,"firstname":"Aaron","lastname":"Baker","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/12838\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1703486386,"firstname":"Aaron","lastname":"Baker","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1703486386\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1622266664,"firstname":"Donna","lastname":"Baker","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1622266664\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1152669863,"firstname":"Dusty","lastname":"Baker","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1152669863\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1323260485,"firstname":"Britney","lastname":"Banks","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1323260485\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":714951450,"firstname":"Marion","lastname":"Barber","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/714951450\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":684696987,"firstname":"RICHARD","lastname":"BARBERENA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/684696987\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":641375714,"firstname":"SANDRA","lastname":"BARBERENA","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/641375714\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1553349196,"firstname":"RACHEL","lastname":"BARKER","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1553349196\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1744756456,"firstname":"Greg","lastname":"Barnes","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1744756456\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":12824,"firstname":"Raechel","lastname":"Barnes","email":null,"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\/user\/12824\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":359059706,"firstname":"Jorge","lastname":"Barrientos","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/359059706\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":2055696035,"firstname":"Rosa","lastname":"Barron","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2055696035\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":377166809,"firstname":"Monica","lastname":"Bartlett","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/377166809\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1353381201,"firstname":"Kelly","lastname":"Barton","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1353381201\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":880364495,"firstname":"Felicia","lastname":"Bass","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/880364495\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1048633671,"firstname":"Mirian","lastname":"Batres","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1048633671\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":2107893464,"firstname":"DUSTY","lastname":"BAUER","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2107893464\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1719667197,"firstname":"Brittany","lastname":"Baugh","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1719667197\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1248745472,"firstname":"Tristyn","lastname":"Bautista","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1248745472\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":517685120,"firstname":"Courtney","lastname":"Baylor","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/517685120\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":922761293,"firstname":"Josh","lastname":"Beacom","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/922761293\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":660448868,"firstname":"Katima","lastname":"Beaver","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/660448868\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1684497160,"firstname":"Issac","lastname":"Becerra","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1684497160\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1354294907,"firstname":"CASEY","lastname":"BECKER","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1354294907\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":2029191516,"firstname":"Pam","lastname":"Beesly","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2029191516\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":142613152,"firstname":"STEVEN","lastname":"BEGNAUD","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/142613152\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1016602881,"firstname":"Thomas","lastname":"Bell","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1016602881\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":723686510,"firstname":"Mia","lastname":"Bella","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/723686510\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":917750084,"firstname":"DANIEL","lastname":"BELTER","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/917750084\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1221534049,"firstname":"Anna","lastname":"Belton","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1221534049\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1013414734,"firstname":"ADRIAN","lastname":"BELTRAN","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1013414734\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1242611016,"firstname":"ALEJANDRO","lastname":"BELTRAN","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1242611016\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":1779567778,"firstname":"Ian","lastname":"Benavidaz","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1779567778\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0},{"id":207076052,"firstname":"QUEMILLE","lastname":"BENITEZ","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/207076052\/","total_course_hours":"0:00:00","total_courses":0,"total_exams":0}]

Get List of a User's Courses

Returns a list of all courses a user is enrolled in with a summary of his or her total training and training information by course (e.g. enrollment/assignment date, due date, total time spent on the course and progress). By default only the first 100 people are returned.

GET /dashboard/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/dashboard/users/14/courses?apikey=schoox&acadId=386

Response Object
Show All
[{"id":21936,"title":"Basics of Social Media Marketing","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/21936\/3KBw1FFSyWFZXK7BihMn_splashmedia_The_basics_of_social_media_marketing.jpg","url":"https:\/\/www.schoox.com\/21936\/basics-of-social-media-marketing","progress":0,"total_time":"0:00:00","enroll_date":"2013-11-22T17:55:40+00:00","certificates":[],"enrolled":false},{"id":43282,"title":"Celebrating Diversity","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/43282\/JAxzQcKLRtSewuCM0T2M_Dollarphotoclub_66025646.jpg","url":"https:\/\/www.schoox.com\/43282\/celebrating-diversity","progress":0,"total_time":"0:00:11","enroll_date":"2015-11-19T15:23:12+00:00","certificates":[],"enrolled":true},{"id":13011,"title":"Customer Service","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/13011\/1362652371630493570.jpg","url":"https:\/\/www.schoox.com\/13011\/customer-service","progress":0,"total_time":"0:00:07","enroll_date":"2013-09-26T18:08:18+00:00","certificates":[],"enrolled":true},{"id":42957,"title":"Ethics in the Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42957\/S3QOlJceRnSTsd9neLhR_Dollarphotoclub_69558035.jpg","url":"https:\/\/www.schoox.com\/42957\/ethics-in-the-workplace","progress":0,"total_time":"0:00:00","enroll_date":"2015-11-19T15:23:15+00:00","certificates":[],"enrolled":true},{"id":11657,"title":"How to serve a table","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11657\/1369906178531902169.jpg","url":"https:\/\/www.schoox.com\/11657\/how-to-serve-a-table","progress":50,"total_time":"0:32:15","enroll_date":"2013-02-11T12:02:31+00:00","certificates":[{"id":16178,"ver_code":"d763c80","total_time":1891,"time_certified":"2013-02-11T13:12:46+00:00","url":"https:\/\/www.schoox.com\/c16178?ver_code=d763c80"}],"enrolled":true,"due_date":"2013-02-20T00:00:00+00:00","is_due":false},{"id":24796,"title":"ServingU Alcohol Certification","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/24796\/aB7d0okRQGrifdCGhhSg_ALCOHOL%20THUMBNAIL%20FINAL%20FINAL%20FINAL.jpg","url":"https:\/\/www.schoox.com\/24796\/servingu-alcohol-certification","progress":10,"total_time":"0:02:25","enroll_date":"2014-04-15T08:43:27+00:00","certificates":[],"enrolled":true},{"id":42953,"title":"Social Media in the Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42953\/SwdkdhpURTeXLQF38kw5_Dollarphotoclub_60768920.jpg","url":"https:\/\/www.schoox.com\/42953\/social-media-in-the-workplace","progress":0,"total_time":"0:00:00","enroll_date":"2015-11-19T15:23:13+00:00","certificates":[],"enrolled":true},{"id":9914,"title":"What's for Dinner: Universal Foods and Certain Preparations","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/9914\/1354895984440391184.jpg","url":"https:\/\/www.schoox.com\/9914\/what%27s-for-dinner%3A-universal-foods-and-certain-preparations","progress":0,"total_time":"0:01:32","enroll_date":"2013-04-04T22:33:53+00:00","certificates":[{"id":35253,"ver_code":"d1dea54","total_time":80,"time_certified":"2013-04-15T15:42:40+00:00","url":"https:\/\/www.schoox.com\/c35253?ver_code=d1dea54"}],"enrolled":true},{"id":11673,"title":"Wine 101","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11673\/YhkSx78JTmuDZGsAp9To_wine101.jpg","url":"https:\/\/www.schoox.com\/11673\/wine-101","progress":0,"total_time":"0:00:00","enroll_date":"2013-09-26T18:08:18+00:00","certificates":[],"enrolled":true}]

Get List of a User's Curriculums

Returns a list of all curriculums a user is enrolled in with a summary of his or her total training and training information by curriculum (e.g. enrollment/assignment date, due date, total time spent on the curriculum and progress). By default only the first 100 people are returned.

GET /dashboard/users/:userid/curriculums

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/dashboard/users/14/curriculums?apikey=schoox&acadId=386

Response Object
Show All
[{"id":37,"title":"Great Food Intro Curriculum","image":"https:\/\/content-cdn3.schoox.com\/content\/thumb\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=37","progress":0,"total_time":"0:32:15","enroll_date":"2014-04-14T00:00:00+00:00"},{"id":39,"title":"Wine Curriculum","image":"https:\/\/content-cdn3.schoox.com\/content\/thumb\/curricula\/39\/d67d8ab4f4c10bf22aa353e27879133c.jpg","url":"https:\/\/www.schoox.com\/academies\/tp\/index.php?tpId=39","progress":0,"total_time":"0:32:22","enroll_date":"2013-09-26T00:00:00+00:00"}]

Get List of a User's Exams

Returns a list of all exams a user has taken so far with information about his or her performance on every exam (e.g. number of attempts, date of last attempt, score, points, passing score). By default only the first 100 people are returned.

GET /dashboard/users/:userid/exams

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/dashboard/users/14/exams?apikey=schoox&acadId=386

Response Object
Show All
[{"id":169,"name":"How to Greet a New Table","description":"Five questions about How to Greet a New Table. This exam provides critical thinking and identifies potential learning gaps.","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","instructions":"Please answer all questions. If you do not know the answer of a question or are not sure skip to the next question. You can come back at the end before submitting the exam. ","attempts":1,"last_attempt":{"date_start":"2013-02-11T13:10:11+00:00","date_end":"2013-02-11T13:10:55+00:00"},"score":80,"points":{"got":40,"all":50},"passed":true},{"id":5495,"name":"QUIZ 1: Celebrating Diversity","description":null,"image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","instructions":"Please select the best answer for each question.","attempts":1,"last_attempt":{"date_start":"2015-01-12T15:08:48+00:00","date_end":"2015-01-12T15:38:48+00:00"},"score":0,"points":{"got":0,"all":4},"passed":false},{"id":317,"name":"What's for Dinner: Universal Foods and Certain Preparations","description":null,"image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","instructions":null,"attempts":1,"last_attempt":{"date_start":"2013-04-05T09:36:27+00:00","date_end":"2013-04-05T09:36:27+00:00"},"score":33,"points":{"got":33,"all":100},"passed":false}]

Get a List of Courses

Returns a list of all courses with title, short description and image.

GET /dashboard/courses

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
role Users' role Yes String employee
Example Request

https://api.schoox.com/v1/dashboard/courses?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":24801,"title":"Alcohol Serving","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/24801\/XhRo7xVRhCMDbZ3cAibA_norwegian_research_shows_high_level_of_serving_alcohol_to_inebriated_customers_large.jpg","students":4,"completion_rate":0,"publish_date":"2014-01-08T12:31:16+00:00"},{"id":21936,"title":"Basics of Social Media Marketing","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/21936\/3KBw1FFSyWFZXK7BihMn_splashmedia_The_basics_of_social_media_marketing.jpg","students":2,"completion_rate":0},{"id":43282,"title":"Celebrating Diversity","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/43282\/JAxzQcKLRtSewuCM0T2M_Dollarphotoclub_66025646.jpg","students":44,"completion_rate":20},{"id":42700,"title":"Communicating with Colleagues","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42700\/ZwdEesxnR3amslNdiVFs_Dollarphotoclub_58085212.jpg","students":5,"completion_rate":40},{"id":37119,"title":"Complaint Resolution","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/37119\/0b4762b132a3b8f4085ed3a34c5312e2.png","students":5,"completion_rate":20},{"id":42707,"title":"Conflict Resolution in the Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42707\/McorOHkGSOSYMxvJZGYS_Dollarphotoclub_70967574.jpg","students":5,"completion_rate":20},{"id":46776,"title":"Coupon Testing Course","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","students":0,"completion_rate":0},{"id":13011,"title":"Customer Service","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/13011\/1362652371630493570.jpg","students":13,"completion_rate":8,"publish_date":"2014-01-08T12:13:01+00:00"},{"id":209372,"title":"Demo Course","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","students":1,"completion_rate":0},{"id":144519,"title":"Demo Course at Ultimate","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","students":1,"completion_rate":0},{"id":42957,"title":"Ethics in the Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42957\/S3QOlJceRnSTsd9neLhR_Dollarphotoclub_69558035.jpg","students":0,"completion_rate":0},{"id":13816,"title":"Food Safety HACCP for Retail Food Establishments","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/13816\/1365076892313944526.jpg","students":5,"completion_rate":20,"publish_date":"2013-04-04T11:58:12+00:00"},{"id":39203,"title":"Greeting a New Table","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/39203\/245f5b82b48a05e1a831fda83b2ddba7.png","students":3,"completion_rate":0},{"id":9442,"title":"How To Greet a New Table","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/9442\/1360027123653193406.jpg","students":7,"completion_rate":14,"publish_date":"2019-02-20T10:24:24+00:00"},{"id":11657,"title":"How to serve a table","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11657\/1369906178531902169.jpg","students":17,"completion_rate":6},{"id":31748,"title":"How to serve alcohol","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/31748\/PXAm4QwpTIGjTTA8SRhw_Howtoservealcohol.jpg","students":2,"completion_rate":0,"publish_date":"2014-06-17T18:27:12+00:00"},{"id":43281,"title":"Incorporating Corporate Values","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/43281\/tnqywSQOSAWpLmp13QO0_Dollarphotoclub_69079031.jpg","students":6,"completion_rate":17},{"id":39211,"title":"Innovative Up-selling","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/39211\/HjmzTCAYRF2vLTnSzckt_Upselling_Techniques.jpg","students":2,"completion_rate":0,"publish_date":"2014-08-18T15:30:36+00:00"},{"id":36838,"title":"Kitchen Lingo","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/36838\/dbbe57d145b97ff2097694f4b826a226.png","students":4,"completion_rate":50},{"id":13805,"title":"Management Basics","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/13805\/1365068841129577460.jpg","students":3,"completion_rate":0},{"id":36535,"title":"Memorizing Your Menu In A Day","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/36535\/751c3220af522af9d395ac75bb050a21.png","students":5,"completion_rate":20},{"id":38260,"title":"Multitasking","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/38260\/e41300382459d9dd2ca43036712f386e.png","students":3,"completion_rate":67},{"id":38208,"title":"Organizing Your Server Book","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/38208\/28309da2c7a4f05682af7b829ab78734.png","students":5,"completion_rate":0},{"id":43270,"title":"OSHA Regulation Compliance","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/43270\/QX37wXufQDK526QjYAwg_Dollarphotoclub_64960486.jpg","students":4,"completion_rate":50},{"id":42934,"title":"Promoting a Drug-Free Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42934\/xR6uMRWdQKQc7oCI5A6g_Dollarphotoclub_52601999.jpg","students":3,"completion_rate":33},{"id":36335,"title":"Seat Assignments and Food Delivery Etiquette","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/36335\/92a3c2a8aa3f4af5c4cad524da66d8e1.png","students":6,"completion_rate":17},{"id":844182,"title":"Server Training 101","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","students":0,"completion_rate":0},{"id":25489,"title":"ServingU Alcohol Certification","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/25489\/n4NsMIgtS0GSsNhepmzw_ALCOHOL%20THUMBNAIL%20FINAL%20FINAL%20FINAL.jpg","students":2,"completion_rate":0,"publish_date":"2014-01-14T12:13:09+00:00"},{"id":24796,"title":"ServingU Alcohol Certification","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/24796\/aB7d0okRQGrifdCGhhSg_ALCOHOL%20THUMBNAIL%20FINAL%20FINAL%20FINAL.jpg","students":13,"completion_rate":0},{"id":42702,"title":"Sexual Harassment in the Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42702\/WU4pgSfjQ02M2qV22sh3_Dollarphotoclub_61345505.jpg","students":9,"completion_rate":67},{"id":42953,"title":"Social Media in the Workplace","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/42953\/SwdkdhpURTeXLQF38kw5_Dollarphotoclub_60768920.jpg","students":3,"completion_rate":0}]

Get a List of Enrolled Users in a Course

Returns a list of enrolled users in a course with a summary of information for every user (e.g. enrollment date, user’s region and location, total time spent on course and total progress).

GET /dashboard/courses/:courseid

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
role Users' role Yes String employee
aboveId Above Unit's ID No Integer 1
unitId Unit's ID No Integer 4
jobId Job's ID No Integer 7
search Search text No String John Doe
start List's starting position No Integer 0
limit Number of users to return per request, up to maximum of 1,000. Default to 100 No Integer 100
sort Sorting criteria No String lastname
order Descending or ascending order No String DESC
Example Request

https://api.schoox.com/v1/dashboard/courses/11657?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":11925,"firstname":"John","lastname":"Alaister","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/11925\/13530717721409572663.jpg","url":"https:\/\/www.schoox.com\/user\/11925\/","enrolment_date":"2013-10-17T00:00:00+00:00","progress":0,"time":"0:00:00","due_date":"1970-01-01T00:00:00+00:00"},{"id":151387,"firstname":"RANDALL","lastname":"ASHFORD","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/151387\/","enrolment_date":"2014-09-22T00:00:00+00:00","progress":0,"time":"0:00:00"},{"id":13317,"firstname":"Manuel","lastname":"Bahs","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13317\/13614612421039648534.jpg","url":"https:\/\/www.schoox.com\/user\/13317\/","enrolment_date":"2016-02-03T00:00:00+00:00","progress":0,"time":"0:00:00","due_date":"2016-02-17T00:00:00+00:00"},{"id":12188,"firstname":"Kostas","lastname":"Demiris","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/12188\/2b3baeca331e80cb2db4913464bda733.png","url":"https:\/\/www.schoox.com\/user\/12188\/","enrolment_date":"2015-09-09T00:00:00+00:00","progress":0,"time":"0:00:00"},{"id":1194032006,"firstname":"Jane","lastname":"Doe","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1194032006\/","enrolment_date":"2018-03-17T00:00:00+00:00","progress":0,"time":"0:00:00","due_date":"2018-03-18T00:00:00+00:00"},{"id":13381,"firstname":"John","lastname":"Harmon","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13381\/a0111a2647da3e80523a3002f6d86044.jpg","url":"https:\/\/www.schoox.com\/user\/13381\/","enrolment_date":"2013-02-16T00:00:00+00:00","progress":100,"time":"7:10:39","due_date":"2013-02-27T00:00:00+00:00","certificates":[{"id":373556,"ver_code":"99752af","total_time":3523,"time_certified":"2014-04-08T13:31:11+00:00","url":"https:\/\/www.schoox.com\/c373556?ver_code=99752af"},{"id":148620,"ver_code":"ee86ef0","total_time":3523,"time_certified":"2014-04-08T13:31:11+00:00","url":"https:\/\/www.schoox.com\/c148620?ver_code=ee86ef0"},{"id":16406,"ver_code":"f961214","total_time":3523,"time_certified":"2014-04-08T13:31:11+00:00","url":"https:\/\/www.schoox.com\/c16406?ver_code=f961214"}]},{"id":7585878,"firstname":"John","lastname":"Hazlewood","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/7585878\/","enrolment_date":"2017-11-18T00:00:00+00:00","progress":0,"time":"0:00:00","due_date":"2017-11-19T00:00:00+00:00"},{"id":11361,"firstname":"John","lastname":"Hazlewood","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/11361\/yfkBLo0LR3W8unKc64gf_ProfilePic.png","url":"https:\/\/www.schoox.com\/user\/11361\/","enrolment_date":"2014-12-22T00:00:00+00:00","progress":17,"time":"0:33:36"},{"id":13393,"firstname":"Mark","lastname":"Holger","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13393\/136112765993805384.jpg","url":"https:\/\/www.schoox.com\/user\/13393\/","enrolment_date":"2013-05-30T00:00:00+00:00","progress":42,"time":"2:56:47","due_date":"2013-06-04T00:00:00+00:00"},{"id":13392,"firstname":"Jennifer","lastname":"Hoover","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13392\/13611263901201807635.jpg","url":"https:\/\/www.schoox.com\/user\/13392\/","enrolment_date":"2013-05-30T00:00:00+00:00","progress":0,"time":"0:02:24","due_date":"2013-06-04T00:00:00+00:00"},{"id":10155,"firstname":"Brandon","lastname":"Hudgeons","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/10155\/7958766.png","url":"https:\/\/www.schoox.com\/user\/10155\/","enrolment_date":"2013-02-11T00:00:00+00:00","progress":17,"time":"0:10:07"},{"id":11189,"firstname":"Cam","lastname":"Lanier","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/11189\/20467f767d4aa32d973ee6f5a02f551b.png","url":"https:\/\/www.schoox.com\/user\/11189\/","enrolment_date":"2013-03-01T00:00:00+00:00","progress":0,"time":"0:00:00"},{"id":13258,"firstname":"Leigh","lastname":"McCormick+","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/13258\/","enrolment_date":"2013-05-30T00:00:00+00:00","progress":0,"time":"0:00:00","due_date":"2013-06-04T00:00:00+00:00"},{"id":229143,"firstname":"John","lastname":"Public","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/229143\/ie83DGGdSNCT3sBoYmdp_p_X9xRPUjQGYessIHbSziw_37161_1641917009407_62266_n.jpg","url":"https:\/\/www.schoox.com\/user\/229143\/","enrolment_date":"2014-10-08T00:00:00+00:00","progress":8,"time":"0:01:21"},{"id":12852,"firstname":"Aaron","lastname":"Romo","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/12852\/","enrolment_date":"2013-06-12T00:00:00+00:00","progress":0,"time":"0:00:00","due_date":"2013-06-19T00:00:00+00:00"},{"id":66535,"firstname":"Eleni","lastname":"Sigkou","email":null,"image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/66535\/","enrolment_date":"2013-10-17T00:00:00+00:00","progress":0,"time":"0:00:00"},{"id":125796,"firstname":"Jim","lastname":"Wahlstrom","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/125796\/egVwUpQUGMAksRE6wCA2_Jim spring 2014(2).jpg","url":"https:\/\/www.schoox.com\/user\/125796\/","enrolment_date":"2014-11-06T00:00:00+00:00","progress":8,"time":"0:00:50"}]

Get detailed Course Progress for a User

Courses can consist of one or more lectures and exams. This request returns detailed information about a user's progress on a course for every single lecture and exam of it (e.g. lecture name, progress, time spent, number of attempts, name of exam, score, date of last attempt).

GET /dashboard/courses/:courseid/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/dashboard/courses/11657/users/14?&role=employee&apikey=schoox&acadId=386

Response Object
Show All
{"lectures":[{"id":5593,"title":"How to Bus a Table","progress":100,"time":"0:03:28"},{"id":5592,"title":"How to set a table","progress":100,"time":"0:07:02"},{"id":22169,"title":"How to serve customers with disabilities","progress":0,"time":"0:00:00"},{"id":31264,"title":"High court refuses to reinstate New York big-soda ban","progress":0,"time":"0:00:00"},{"id":5590,"title":"Taking an order","progress":100,"time":"0:02:35"},{"id":5591,"title":"Staff Training Restaurant Intro","progress":100,"time":"0:08:59"},{"id":5595,"title":"Dealing With Angry Customers","progress":0,"time":"0:00:00"},{"id":5594,"title":"Waitstaff opening checklist","progress":100,"time":"0:09:27"},{"id":5596,"title":"Hygienic food preparation","progress":0,"time":"0:00:00"},{"id":5597,"title":"Customer Service Training Video","progress":0,"time":"0:00:00"}],"exams":[{"id":169,"title":"How to Greet a New Table","last_attempt":"1970-01-01T00:00:00+00:00","passed":true,"score":80,"points":{"got":40,"all":50}},{"id":3196,"title":"Steve's Test","last_attempt":"1970-01-01T00:00:00+00:00","passed":false,"score":0,"points":{"got":0,"all":0}},{"id":3305,"title":"Exam","last_attempt":"1970-01-01T00:00:00+00:00","passed":false,"score":0,"points":{"got":0,"all":0}},{"id":3359,"title":"How to Serve Bread - Exam","last_attempt":"1970-01-01T00:00:00+00:00","passed":false,"score":0,"points":{"got":0,"all":0}},{"id":3858,"title":"Test Exam","last_attempt":"1970-01-01T00:00:00+00:00","passed":false,"score":0,"points":{"got":0,"all":0}},{"id":4101,"title":"demo","last_attempt":"1970-01-01T00:00:00+00:00","passed":false,"score":0,"points":{"got":0,"all":0}}],"certificates":[{"id":16178,"ver_code":"d763c80","total_time":1891,"time_certified":"2013-02-11T13:12:46+00:00","url":"https:\/\/www.schoox.com\/c16178?ver_code=d763c80"}]}

Get a List of Curriculums

Returns a list of all curriculums with title, short description, image and number of courses.

GET /dashboard/curriculums

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
role Users' role Yes String employee
Example Request

https://api.schoox.com/v1/dashboard/curriculums?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":37,"title":"Great Food Intro Curriculum","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","students":4,"completion_rate":0,"publish_date":"2013-02-09T22:21:40+00:00"},{"id":38,"title":"Customer Service","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/38\/a5771bce93e200c36f7cd9dfd0e5deaa.jpg","students":4,"completion_rate":0,"publish_date":"2013-02-09T22:25:00+00:00"},{"id":39,"title":"Wine Curriculum","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/39\/d67d8ab4f4c10bf22aa353e27879133c.jpg","students":4,"completion_rate":0,"publish_date":"2013-02-09T22:28:13+00:00"},{"id":250,"title":"Curriculum for new employees","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","students":1,"completion_rate":0,"publish_date":"2013-10-06T10:16:16+00:00"},{"id":1196,"title":"Red Book Connect SchooX Courses","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/1196\/aSllN50QQkeKAmEXjeAl_Screen Shot 2014-10-14 at 5.18.36 PM.png","students":0,"completion_rate":0,"publish_date":"2014-08-10T13:28:48+00:00"},{"id":1308,"title":"Innovalearn Curriculum","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","students":0,"completion_rate":0,"publish_date":"2014-10-25T08:33:00+00:00"}]

Get a List of Enrolled Users in a Curriculum

Returns a list of enrolled users in a curriculum with a summary of information for every user (e.g. enrollment date, total time spent on the curriculum and total progress).

GET /dashboard/curriculums/:curriculumid

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
role Users' role Yes String employee
aboveId Above Unit's ID No Integer 1
unitId Unit's ID No Integer 4
jobId Job's ID No Integer 7
search Search text No String John Doe
start List's starting position No Integer 0
limit 'Number of users to return per request, up to maximum of 1,000. Default to 100 No Integer 100
sort Sorting criteria No String firstname
order Descending or ascending order No String DESC
Example Request

https://api.schoox.com/v1/dashboard/curriculums/37?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":11925,"firstname":"John","lastname":"Alaister","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","enrolment_date":"2013-10-17T00:00:00+00:00","due_date":"2013-10-22T00:00:00+00:00","timecompleted":"2016-09-27T10:19:17+00:00","progress":100,"time":"0:00:00"},{"id":13381,"firstname":"John","lastname":"Harmon","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13381\/a0111a2647da3e80523a3002f6d86044.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13381","enrolment_date":"2013-03-05T00:00:00+00:00","timecompleted":"2014-04-08T13:31:11+00:00","progress":100,"time":"7:44:36"},{"id":66535,"firstname":"Eleni","lastname":"Sigkou","image":"https:\/\/static-cdn.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=66535","enrolment_date":"2013-10-17T00:00:00+00:00","progress":0,"time":"0:00:00"},{"id":9538,"firstname":"John","lastname":"Smith","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/9538\/13334262631509726578.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=9538","enrolment_date":"2013-10-17T00:00:00+00:00","progress":0,"time":"0:42:31"}]

Get detailed Curriculum Progress for a User

Curriculums can consist of one or more courses. This request returns detailed information about a user’s progress on a curriculum for every single course of it (e.g. course name, image, time spent and total progress).

GET /dashboard/curriculums/:curriculumid/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/dashboard/curriculums/37/users/14?&role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":11657,"title":"How to serve a table","time":"0:32:15","progress":50},{"id":11673,"title":"Wine 101","time":"0:00:00","progress":0}]

Get a List of Exams

Returns a list of all exams with title, image and publishing date.

GET /dashboard/exams

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
role Users' role Yes String employee
Example Request

https://api.schoox.com/v1/dashboard/exams?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":23,"name":"How to Greet a New Table","image":"https:\/\/content-cdn3.schoox.com\/content\/1\/exams\/23\/be8ed0890b22f51c21abc7cddfce16af.png","students":3,"success_rate":67,"average_score":100},{"id":169,"name":"How to Greet a New Table","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":6,"success_rate":50,"average_score":78},{"id":309,"name":"Management Basics Quiz","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":50,"average_score":50},{"id":311,"name":"Food Safety","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":3,"success_rate":67,"average_score":83},{"id":1813,"name":"Comprehensive Final Exam","image":"https:\/\/content-cdn3.schoox.com\/content\/1\/exams\/1813\/quiz_5.jpg","students":2,"success_rate":50,"average_score":89},{"id":1815,"name":"Defining Characteristics Quiz","image":"https:\/\/content-cdn3.schoox.com\/content\/1\/exams\/1815\/quiz_1.jpg","students":4,"success_rate":50,"average_score":72},{"id":1816,"name":"Responsibility Quiz","image":"https:\/\/content-cdn3.schoox.com\/content\/1\/exams\/1816\/quiz_2.jpg","students":4,"success_rate":50,"average_score":63},{"id":1817,"name":"Overserving Quiz","image":"https:\/\/content-cdn3.schoox.com\/content\/1\/exams\/1817\/quiz_4.jpg","students":2,"success_rate":100,"average_score":90},{"id":1818,"name":"Procedures Quiz","image":"https:\/\/content-cdn3.schoox.com\/content\/1\/exams\/1818\/quiz_3.jpg","students":3,"success_rate":67,"average_score":76},{"id":1899,"name":"Defining Characteristics Quiz","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":50,"average_score":45},{"id":1900,"name":"Responsibility Quiz","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":90},{"id":1901,"name":"Overserving Quiz","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":50},{"id":1902,"name":"Procedures Quiz","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":0},{"id":1903,"name":"Comprehensive Final Exam","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":0},{"id":3196,"name":"Steve's Test","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":0},{"id":3305,"name":"Exam","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":0,"average_score":0},{"id":3359,"name":"How to Serve Bread - Exam","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":6,"success_rate":33,"average_score":60},{"id":3858,"name":"Test Exam","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":0},{"id":4086,"name":"QUIZ 1: Seat Assignments and Food Delivery Etiquette","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":92},{"id":4087,"name":"QUIZ 2: Seat Assignments and Food Delivery Etiquette","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":85},{"id":4089,"name":"Comprehensive Exam: Seat Assignments and Food Delivery Etiquette","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":92},{"id":4101,"name":"demo","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":0},{"id":4115,"name":"QUIZ 1: Memorizing Your Menu","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":3,"success_rate":100,"average_score":95},{"id":4116,"name":"QUIZ 2: Memorizing Your Menu","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":3,"success_rate":33,"average_score":42},{"id":4127,"name":"Comprehensive Exam: Memorizing Your Menu","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":80},{"id":4159,"name":"QUIZ 1: Kitchen Lingo","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":3,"success_rate":67,"average_score":73},{"id":4160,"name":"QUIZ 2: Kitchen Lingo","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":95},{"id":4162,"name":"Comprehensive Exam: Kitchen Lingo","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100},{"id":4210,"name":"QUIZ 1: Complaint Resolution","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4212,"name":"QUIZ 2: Complaint Resolution","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4214,"name":"Comprehensive Exam: Conflict Resolution","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4306,"name":"QUIZ 1: Upselling","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4307,"name":"QUIZ 2: Upselling","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4309,"name":"QUIZ 3: Upselling","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4311,"name":"Comprehensive Exam: Upselling","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4372,"name":"QUIZ 1: Organizing Your Server Book","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4373,"name":"QUIZ 2: Organizing Your Server Book","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4374,"name":"QUIZ 3: Organizing Your Server Book","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4377,"name":"Comprehensive Exam: Organizing Your Server Book","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":75},{"id":4383,"name":"QUIZ 1: Multitasking","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100},{"id":4384,"name":"QUIZ 2: Multitasking","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100},{"id":4386,"name":"Comprehensive Exam\" Multitasking","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100},{"id":4589,"name":"QUIZ 1: Greeting a New Table","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":80},{"id":4590,"name":"QUIZ 2: Greeting a New Table","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4591,"name":"QUIZ 3: Greeting a New Table","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":0,"average_score":66},{"id":4592,"name":"Comprehensive Exam: Greeting a New Table","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4606,"name":"QUIZ 1: Timing Your Tables","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":4607,"name":"QUIZ 2: Timing Your Tables","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":88},{"id":4608,"name":"Comprehensive Exam: Timing Your Tables","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":5184,"name":"Comprehensive Exam: Communicating with Colleagues","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5185,"name":"Comprehensive Exam: Workplace Bullying","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5187,"name":"Comprehensive Exam: Conflict Resolution in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5235,"name":"Comprehensive Exam: Promoting a Drug-Free Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5241,"name":"Comprehensive Exam: Social Media in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5244,"name":"Comprehensive Exam: Ethics in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5309,"name":"Comprehensive Exam: OSHA Regulation Compliance","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5312,"name":"Comprehensive Exam: Incorporating Corporate Values","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5314,"name":"Comprehensive Exam: Celebrating Diversity","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5495,"name":"QUIZ 1: Celebrating Diversity","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":11,"success_rate":91,"average_score":90},{"id":5496,"name":"QUIZ 2: Celebrating Diversity","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":10,"success_rate":100,"average_score":100},{"id":5497,"name":"QUIZ 1: Incorporating Corporate Values","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":5498,"name":"QUIZ 2: Incorporating Corporate Values","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5499,"name":"QUIZ 1: OSHA Regulation Compliance","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100},{"id":5500,"name":"QUIZ 2: OSHA Regulation Compliance","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100},{"id":5501,"name":"QUIZ 1: Ethics in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5502,"name":"QUIZ 2: Ethics in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5503,"name":"QUIZ 1: Social Media in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5504,"name":"QUIZ 2: Social Media in the Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":0,"success_rate":0,"average_score":0},{"id":5505,"name":"QUIZ 1: Promoting a Drug-Free Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":5506,"name":"QUIZ 2: Promoting a Drug-Free Workplace","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":5510,"name":"QUIZ 1: Conflict Resolution","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":5511,"name":"QUIZ 2: Conflict Resolution","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":1,"success_rate":100,"average_score":100},{"id":5512,"name":"QUIZ 1: Workplace Bullying","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":10,"success_rate":90,"average_score":90}]

Get a List of Enrolled Users in an Exam

This returns a list of all users for an exam with detailed information about every user's performance (e.g. user’s name, number of attempts, date of last attempt, starting date, ending date, score, points and status: passed / failed).

GET /dashboard/exams/:examid

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
role Users' role Yes String employee
aboveId Above Unit's ID No Integer 1
unitId Unit's ID No Integer 4
jobId Job's ID No Integer 7
search Search text No String John Doe
start List's starting position No Integer 0
limit 'Number of users to return per request, up to maximum of 1,000. Default to 100 No Integer 100
sort Sorting criteria No String firstname
order Descending or ascending order No String DESC
Example Request

https://api.schoox.com/v1/dashboard/exams/169?role=employee&apikey=schoox&acadId=386

Response Object
Show All
[{"id":11925,"firstname":"John","lastname":"Alaister","email":null,"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","attempts":0,"last_attempt":"1970-01-01T00:00:00+00:00","passed":false,"score":0,"points":{"got":0,"all":0}},{"id":13381,"firstname":"John","lastname":"Harmon","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13381\/a0111a2647da3e80523a3002f6d86044.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13381","attempts":44,"last_attempt":"2013-03-07T00:00:00+00:00","passed":true,"score":100,"points":{"got":50,"all":50}},{"id":13393,"firstname":"Mark","lastname":"Holger","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13393\/136112765993805384.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13393","attempts":25,"last_attempt":"2014-03-27T00:00:00+00:00","passed":true,"score":88,"points":{"got":40,"all":45}},{"id":13392,"firstname":"Jennifer","lastname":"Hoover","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13392\/13611263901201807635.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=13392","attempts":1,"last_attempt":"2014-06-27T00:00:00+00:00","passed":false,"score":42,"points":{"got":19,"all":45}},{"id":10155,"firstname":"Brandon","lastname":"Hudgeons","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/10155\/7958766.png","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=10155","attempts":1,"last_attempt":"2014-08-08T00:00:00+00:00","passed":true,"score":100,"points":{"got":45,"all":45}},{"id":229143,"firstname":"John","lastname":"Public","email":null,"image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/229143\/ie83DGGdSNCT3sBoYmdp_p_X9xRPUjQGYessIHbSziw_37161_1641917009407_62266_n.jpg","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=386&user=229143","attempts":1,"last_attempt":"2014-10-22T00:00:00+00:00","passed":false,"score":62,"points":{"got":28,"all":45}}]