API Documentation

API usage

The following requests relate to getting information regarding the usage of the Schoox Academy API. Note: All requests must be Authenticated.

Remaining calls

Returns the remaining calls according to your plan.

GET /usage

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

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

Response Object
Show All
{"availableCalls":2999,"until":"08\/24\/2019 10:40:51 pm"}