The information API can be used to get a list of schedules or forms in your account and their internal IDs. It also provides endpoints to inquire about other objects, such as endpoints that list the services, resources and groups.
Authentication
You need to include your API key with each request, as a header or a parameter. Please refer to the Authentication page for details.
List Schedules or Forms in an account
You can retrieve a list of schedules or forms from an account through the API by using /api/schedules or /api/super_forms respectively.
These require that the account name and api_key are passed URL parameters or as Basic Auth.
Example
https://www.supersaas.com/api/schedules.json?account=accountname&api_key=your_api_key
https://www.supersaas.com/api/super_forms.json?account=accountname&api_key=your_api_key
The API will return an array of tuples containing the schedule IDs and schedule names.
List Resources or Service in a schedule
Send an HTTP GET request to www.supersaas.com/api/resources and include the following parameters:
| Field | Comment |
|---|---|
schedule_id | The ID of the schedule for which to list the Resources or Services |
Example
https://www.supersaas.com/api/resources.json?schedule_id=999999&account=accountname&api_key=your_api_key
The API will return an array of tuples, containing the IDs and names of the resources or services.
It is not possible to use this API on a Capacity schedule.
You can select whether this call should return a result as JSON or XML by adding .xml or .json at the end of the URL.
List available fields on the Schedule or User object
Send an HTTP GET request to www.supersaas.com/api/field_list and include the following parameters:
| Field | Comment |
|---|---|
schedule_id(optional) | The ID of the schedule, omit this parameter to list the fields for the User object |
Example
https://www.supersaas.com/api/field_list.json?schedule_id=999999&account=accountname&api_key=your_api_key
The API will return a JSON encoded field list.
List Groups in an account
Send an HTTP GET request towww.supersaas.com/api/groups
Example
https://www.supersaas.com/api/groups?account=accountname&api_key=your_api_key
If any groups have been defined in the account, the API will return an array of tuples, containing the IDs and names of the groups.