Users

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

Query parameters

Example Request

https://api.schoox.com/v1/users?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object

[{"id":473159548,"firstname":"Frank","middlename":null,"lastname":"Doe","preferred_name":"test","email":"John.Doe1@schoox.com","active":true,"hired_date":null,"image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/academies\/profile.php?acadId=226581108&user=473159548","custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"address":null,"hourly_worker":false,"joined_date":"2022-01-26","last_login":null,"mobile":null,"phone":null,"registration_fields":[],"state":null,"zip":null,"modified_at":"2023-09-19 09:20:31","username":"testuser","roles":["employee"],"external_ids":["1234ACEF"]},{"id":2099521483,"firstname":"John","middlename":null,"lastname":"Doe","preferred_name":null,"email":"John.Doe1@schoox.com","active":true,"hired_date":null,"image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/academies\/profile.php?acadId=226581108&user=2099521483","custom_fields":[{"Custom Date":"2021-07-12"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan","jobs":[{"id":1009130,"name":"Cashier"}]}],"above_units":[{"id":1286994,"name":"New York"}],"address":null,"hourly_worker":false,"joined_date":"2021-11-30","last_login":null,"mobile":null,"phone":null,"registration_fields":[],"state":null,"zip":null,"modified_at":"2023-02-22 16:48:49","username":"","roles":["employee"],"external_ids":["12345ABCD"]},{"id":228779921,"firstname":"Academy","middlename":null,"lastname":"Instructor","preferred_name":null,"email":"John.Doe1@schoox.com","active":true,"hired_date":null,"image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/academies\/profile.php?acadId=226581108&user=228779921","custom_fields":[{"Custom Date":""},{"Custom Text Field":""}],"units":[],"above_units":[],"address":null,"hourly_worker":false,"joined_date":"2022-08-26","last_login":null,"mobile":null,"phone":null,"registration_fields":[],"state":null,"zip":null,"modified_at":"2022-08-26 13:30:28","username":"","roles":["training_manager","employee"],"external_ids":[]},{"id":2016854398,"firstname":"Security","middlename":"","lastname":"Review","preferred_name":null,"email":"John.Doe1@schoox.com","active":true,"hired_date":null,"image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/academies\/profile.php?acadId=226581108&user=2016854398","custom_fields":[{"Custom Date":""},{"Custom Text Field":""}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"address":"","hourly_worker":false,"joined_date":"2022-12-13","last_login":"2022-12-13 23:16:26","mobile":"","phone":"","registration_fields":[],"state":"","zip":"","modified_at":"2022-12-13 23:16:26","username":"","roles":["employee"],"external_ids":["999999998"]},{"id":1520241641,"firstname":"Security","middlename":"","lastname":"User","preferred_name":null,"email":"John.Doe1@schoox.com","active":true,"hired_date":null,"image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/academies\/profile.php?acadId=226581108&user=1520241641","custom_fields":[{"Custom Date":""},{"Custom Text Field":""}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"address":"","hourly_worker":false,"joined_date":"2022-12-13","last_login":"2022-12-14 05:20:21","mobile":"","phone":"","registration_fields":[],"state":"","zip":"","modified_at":"2022-12-14 05:20:21","username":"","roles":["admin","training_manager","employee"],"external_ids":["9999999988"]}]

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

Query parameters

Example Request

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

Response Object

{"id":2099521483,"firstname":"John","lastname":"Doe","preferred_name":null,"email":"John.Doe1@schoox.com","external_ids":["12345ABCD"],"username":"","joined_date":"2021-11-30","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/user\/2099521483\/","active":true,"phone":null,"mobile":null,"city":null,"country":null,"country_code":null,"state":null,"address":null,"zip":null,"middlename":null,"custom_fields":[{"Custom Date":"2021-07-12"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan","jobs":[{"id":1009130,"name":"Cashier"}]}],"above_units":[{"id":1286994,"name":"New York"}],"registration_fields":[],"last_login":null,"modified_at":"2023-02-22 16:48:49","hourly_worker":false,"hired_date":null,"roles":["employee"],"certificates":[{"id":188154098,"course_id":3703886,"ver_code":"b643417","total_time":"0:00:00","time_certified":"2022-08-26T13:03:49+00:00","url":"https:\/\/app.schoox.com\/c188154098?ver_code=b643417"}]}

List User's Badges

Returns a list of user's academy badges.

GET /users/:userid/badges

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/badges?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object

[{"id":19648,"name":"Great Speaker","image":"https:\/\/badger.schoox.com\/?rRibbon=3c4a51&lRibbon=3c4a51&icon=instructor&iColor=3c4a51&back=ffffff&type=hexagon1&iBorder=5cc900&oBorder=169be7&scale=1&text=","count":1,"sender":"Dev Team","date":"2022-01-24 17:14:57 UTC"}]

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.

Profile picture is optional. The field must contain the profile picture of the user base64 encoded.

Language field can either be the language's name, or the language's IETF code representation. All supported languages are shown below, as well as all supported values.

• Afrikaans: "Afrikaans", "AF"
• Arabic: "Arabic", "AR"
• Armenian: "Armenian", "HY"
• Belarusian: "Belarusian", "BE"
• Bulgarian: "Bulgarian", "BG"
• Burmese: "Burmese", "MY"
• Catalan: "Catalan", "CA"
• Chinese: "Chinese", "ZH"
• Chinese (Traditional): "Chinese (Traditional)", "ZH-HK"
• Croatian: "Croatian", "HR"
• Czech: "Czech", "CS"
• Danish: "Danish", "DA"
• Dutch: "Dutch", "NL"
• English: "English", "EN"
• Esperanto: "Esperanto", "ESP"
• Estonian: "Estonian", "ET"
• Filipino: "Filipino", "PH"
• Finnish: "Finnish", "FI"
• French: "French", "FR"
• French Canadian: "French Canadian", "FR-CA"
• German: "German", "DE"
• Greek: "Greek", "EL"
• Haitian: "Haitian", "HT"
• Hebrew: "Hebrew", "HE"
• Hindi: "Hindi", "HI"
• Hungarian: "Hungarian", "HU"
• Icelandic: "Icelandic", "IS"
• Indonesian: "Indonesian", "ID"
• Italian: "Italian", "IT"
• Japanese: "Japanese", "JA"
• Khmer: "Khmer", "KM"
• Korean: "Korean", "KO"
• Latvian: "Latvian", "LV"
• Lithuanian: "Lithuanian", "LT"
• Malay: "Malay", "MS"
• Norwegian: "Norwegian", "NO"
• Persian: "Persian", "FA"
• Polish: "Polish", "PL"
• Portuguese: "Portuguese", "PT"
• Portuguese (Brazil): "Portuguese (Brazil)", "PT-BR"
• Romanian: "Romanian", "RO"
• Russian: "Russian", "RU"
• Serbian: "Serbian", "SR"
• Slovak: "Slovak", "SK"
• Slovenian: "Slovenian", "SL"
• Spanish (Europe): "Spanish (Europe)", "ES"
• Spanish (Latin America): "Spanish (Latin America)", "ES-419"
• Swahili: "Swahili", "SW"
• Swedish: "Swedish", "SV"
• Thai: "Thai", "TH"
• Turkish: "Turkish", "TR"
• UK English: "UK English", "en-GB"
• Ukrainian: "Ukrainian", "UK"
• Urdu (Pakistani): "Urdu (Pakistani)", "UR"
• Vietnamese: "Vietnamese", "VI"

POST /users

Query parameters

Example Request

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

Request Object

{"firstname":"John", "lastname":"Doe", "password":"jRJqPVPHZYSeDXPU","profile_picture":"iVBORw0KGgoAAAANSUh...9v8BFUIYJJ9+npkAAAAASUVORK5CYII=", "welcomeEmail": true, "roles":["employee"],"email":"John.Doe1@schoox.com","external_ids": ["ABCDEF", "1234GH"],"above_ids":[18],"unit_ids":[4],"jobs":[{"unit_id":4, "jobs":[2455]},{"above_id":18, "jobs":[1]}], "language":"English", "hired_date":"2021-10-15", "middlename":"J.", "employee_type":"Manager", "employee_number":"AurW323", "custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"},{"Custom Dropdown Field":"Dropdown value"},{"Custom Datetime":"2021-08-20 12:30:00"}]}

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

Query parameters

Example Request

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

Request Object

[{"firstname":"John", "lastname":"Doe", "password":"jRJqPVPHZYSeDXPU","profile_picture":"iVBORw0KGgoAAAANSUh...9v8BFUIYJJ9+npkAAAAASUVORK5CYII=", "welcomeEmail": true, "roles":["employee"],"email":"John.Doe1@schoox.com","above_ids":[18],"unit_ids":[4],"jobs":[{"unit_id":4, "jobs":[2455]},{"above_id":18, "jobs":[1]}], "language":"English", "custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"},{"Custom Dropdown Field":"Dropdown value"},{"Custom Datetime":"2021-08-20 12:30:00"}]}]

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

Query parameters

Example Request

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

Request Object

{"firstname":"John", "lastname":"Doe", "email":"John.Doe1@schoox.com","roles":["employee"],"above_ids":[1],"unit_ids":[4],"job_ids":[1,4],"external_ids":["ABCDEF", "1234GH"]}

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

Query parameters

Example Request

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

Request Object

[{"firstname":"John", "lastname":"Doe", "email":"John.Doe1@schoox.com","roles":["employee"],"above_ids":[1],"unit_ids":[4],"job_ids":[1,4],"external_ids":["ABCDEF", "1234GH"]}]

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.

Profile picture is optional. The field must contain the profile picture of the user base64 encoded. Leave blank to delete the picture.

Language field can either be the language's name, or the language's IETF code representation. All supported languages are shown below, as well as all supported values.

• Afrikaans: "Afrikaans", "AF"
• Arabic: "Arabic", "AR"
• Armenian: "Armenian", "HY"
• Belarusian: "Belarusian", "BE"
• Bulgarian: "Bulgarian", "BG"
• Burmese: "Burmese", "MY"
• Catalan: "Catalan", "CA"
• Chinese: "Chinese", "ZH"
• Chinese (Traditional): "Chinese (Traditional)", "ZH-HK"
• Croatian: "Croatian", "HR"
• Czech: "Czech", "CS"
• Danish: "Danish", "DA"
• Dutch: "Dutch", "NL"
• English: "English", "EN"
• Esperanto: "Esperanto", "ESP"
• Estonian: "Estonian", "ET"
• Filipino: "Filipino", "PH"
• Finnish: "Finnish", "FI"
• French: "French", "FR"
• French Canadian: "French Canadian", "FR-CA"
• German: "German", "DE"
• Greek: "Greek", "EL"
• Haitian: "Haitian", "HT"
• Hebrew: "Hebrew", "HE"
• Hindi: "Hindi", "HI"
• Hungarian: "Hungarian", "HU"
• Icelandic: "Icelandic", "IS"
• Indonesian: "Indonesian", "ID"
• Italian: "Italian", "IT"
• Japanese: "Japanese", "JA"
• Khmer: "Khmer", "KM"
• Korean: "Korean", "KO"
• Latvian: "Latvian", "LV"
• Lithuanian: "Lithuanian", "LT"
• Malay: "Malay", "MS"
• Norwegian: "Norwegian", "NO"
• Persian: "Persian", "FA"
• Polish: "Polish", "PL"
• Portuguese: "Portuguese", "PT"
• Portuguese (Brazil): "Portuguese (Brazil)", "PT-BR"
• Romanian: "Romanian", "RO"
• Russian: "Russian", "RU"
• Serbian: "Serbian", "SR"
• Slovak: "Slovak", "SK"
• Slovenian: "Slovenian", "SL"
• Spanish (Europe): "Spanish (Europe)", "ES"
• Spanish (Latin America): "Spanish (Latin America)", "ES-419"
• Swahili: "Swahili", "SW"
• Swedish: "Swedish", "SV"
• Thai: "Thai", "TH"
• Turkish: "Turkish", "TR"
• UK English: "UK English", "en-GB"
• Ukrainian: "Ukrainian", "UK"
• Urdu (Pakistani): "Urdu (Pakistani)", "UR"
• Vietnamese: "Vietnamese", "VI"

PUT /users/:userid

Query parameters

Example Request

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

Request Object

{"firstname":"John","lastname":"Doe","email":"John.Doe1@schoox.com","password":"jRJqPVPHZYSeDXPU","profile_picture":"iVBORw0KGgoAAAANSUh...9v8BFUIYJJ9+npkAAAAASUVORK5CYII=","external_ids":["ABCDEF", "1234GH"], "custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"},{"Custom Dropdown Field":"Dropdown value"},{"Custom Datetime":"2021-08-20 12:30:00"}]}

Remove a User

Removes a user from the academy.

DELETE /v1/users/:userid

Query parameters

Example Request

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

Reactivate a User

Reactivates a Past Employee as Employee. You can use the User Id or his/her external_id

POST /users

Query parameters

Example Request

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

Request Object

{"id":"3"}

{"external_id":"1001417"}

Add a New Job

Creates a new job. You can also use external_id.

POST /jobs

Query parameters

Example Request

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

Request Object

{"name":"API Developer", "report_id": 4945,"external_id":"api"}

Bulk New Jobs

Creates multiple academy jobs via a single request.

POST /jobs/bulk

Query parameters

Example Request

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

Request Object

[{"name":"API Developer"},{"name":"API Evangelist","report_id":5}]

Edit a Job

Changes the name and/or the external id of a job.

PUT /jobs/:jobid

Query parameters

Example Request

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

Request Object

{"name":"API Developer", "external_id":"extID123"}

Delete a Job

Deletes a specified job. It also removes the job from all assigned users.

DELETE /jobs/:jobid

Query parameters

Example Request

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

List Jobs

Returns a list with all jobs of your Academy.

GET /jobs

Query parameters

Example Request

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

Response Object

[{"id":1009128,"name":"Unit Manager","external_id":null,"deletable":false},{"id":1009129,"name":"Assistant Unit Manager","external_id":null,"deletable":false},{"id":1010472,"name":"Head of City","external_id":null,"deletable":false},{"id":1200024,"name":"API Developer","external_id":"Freshjob","deletable":true,"report_id":4945},{"id":1010473,"name":"Assistant Head of City","external_id":null,"deletable":false},{"id":1009130,"name":"Cashier","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

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/roles?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

["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

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/jobs?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

[{"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

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/units?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

[4]

Remove Unit from a User

Removes a Unit from a given User

DELETE /users/:userid/units/:unitid

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/units/1006485?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Add Above Units to a User

Adds Aboves Units to a given User by an array of Above Unit Ids.

PUT /users/:userid/aboves

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/aboves?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

[11,12]

Remove Above Unit from a User

Removes an Above Unit from a given User

DELETE /users/:userid/aboves/:aboveid

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/aboves/1006485?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Add a New Type

Creates a new Type.

POST /types

Query parameters

Example Request

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

Request Object

{"name":"Region"}

Bulk New Types

Creates multiple Types via a single request.

POST /types/bulk

Query parameters

Example Request

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

Request Object

[{"name":"Region"}, {"name":"Contract"}]

Edit a Type

Changes the name of a Type.

PUT /types/:typeid

Query parameters

Example Request

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

Request Object

{"name":"Region"}

Delete a Type

Deletes a specified type.

DELETE /types/:typeid

Query parameters

Example Request

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

List Types

Returns a list of all Types of your Academy.

GET /types

Query parameters

Example Request

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

Response Object

[{"id":328339,"name":"City"}]

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

Query parameters

Example Request

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

Request Object

{"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

Query parameters

Example Request

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

Request Object

[{"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

Query parameters

Example Request

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

Request Object

{"name":"United States","parent_id":5}

Delete an Above Unit

Deletes a specific Above Unit.

DELETE /aboves/:aboveid

Query parameters

Example Request

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

List Above Units

Returns a list of Above Units (max. 100/request) of your Academy.

GET /aboves

Query parameters

Example Request

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

Response Object

[{"id":1286994,"name":"New York","type_id":328339,"external_id":null,"parent_id":0,"parent_external_id":null},{"id":1698729,"name":"testabove","type_id":328339,"external_id":"","parent_id":0,"parent_external_id":null},{"id":1698878,"name":"testabovenew","type_id":328339,"external_id":"123","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

Query parameters

Example Request

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

Request Object

{"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

Query parameters

Example Request

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

Request Object

[{"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

Query parameters

Example Request

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

Request Object

{"name":"Austin, TX", "above_ids":[110], "external_id": "AUSTIN.TX"}

Delete a Unit

Deletes a specific Unit.

DELETE /units/:unitid

Query parameters

Example Request

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

List Units

Returns a list of Units of your Academy.

GET /units

Query parameters

Example Request

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

Response Object

[{"id":1006485,"name":"NY - Manhattan","external_id":null,"above_ids":[{"id":1286994,"name":"New York","type":"City"}]}]

Archive a Unit

Archive a Unit.

PUT /units/:unitid

Query parameters

Example Request

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

Request Object

{"archive":true}

Unarchive a Unit

Unarchive a Unit.

PUT /units/archived/:unitid

Query parameters

Example Request

https://api.schoox.com/v1/units/archived/1006485?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

{"archive":false}

Delete an Archived Unit

Deletes a specific Archived Unit.

DELETE /units/archived/:unitid

Query parameters

Example Request

https://api.schoox.com/v1/units/archived/1006485?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

List Archived Units

Returns a list of Archived Units of your Academy.

GET /units/archived

Query parameters

Example Request

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

Response Object

[{"id":1024885,"name":"NY - Brooklyn"}]

Assign Courses

Assigns one or more courses (max. 10/request) to a user.

PUT /users/:userid/courses

Query parameters

Example Request

https://api.schoox.com/v1/users/3703886/courses?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

{"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

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/courses_unassign?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

{"courses":[1,2,3]}

Assign Learning paths

Assigns one or more learning paths (max. 10/request) to a user.

PUT /users/:userid/curricula

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/curricula?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

{"curricula":[1,2,3],"dueDays":2,"message":"Sample message"}

Unassign Learning paths

Unassigns one or more learning paths (max. 10/request) from a user.

PUT /users/:userid/curricula_unassign

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/curricula_unassign?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

{"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

Query parameters

Example Request

https://api.schoox.com/v1/users/2099521483/lectures?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object

{"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/:eventid/events

Query parameters

Example Request

https://api.schoox.com/v1/users/729712/events?userIds=[2099521483]&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object

User does not exist