Welcome to the OnTime API documentation. The OnTime API allows OnTime customers to develop applications that interface with the data contained in an OnTime account over the internet. The OnTime API allows numerous ways to access and manipulate the data associated with an OnTime account. There are two versions of the OnTime API: a SOAP implementation and a REST implementation. Both of these implementations provide identical functionality, which allows developers to choose whichever implementation best suits their development needs.
Included in this documentation is a complete description of all possible operations as well as details about the various data models in the OnTime API. This documentation also includes guides for common operations such as accessing data and samples of their use with the APIs.
SOAP and REST API URIs
The SOAP and REST API endpoints for a particular account are located at a URI that is specific to that account. The following URIs are templates of the URI that should be used to access the APIs for an OnTime account. If you do not know the OnTime API URI for the account that you are working with, please contact the account administrator to obtain this URI.
Each OnTime account has a unique URI to access the API. Be sure to replace {company-id} with the ID of the desired account. For example, an account with the Company ID "SAMPLE" would use the following URI to access the REST API:
https://secure.ontime360.com/sites/SAMPLE/api
Explore the OnTime REST API
The OnTime REST API complies with OpenAPI standards and can be used with a number of tools to speed up development. Swagger definitions make it easy to create proxies and other strongly typed interfaces.
The OnTime REST API integrates well with popular IT and development tools, such as Postman. These tools make it simple to explore and experiment with an API before, during, and after development. Or skip the tools and use the built-in Swagger UI to explore and interact with the OnTime API. Access the Swagger UI page by adding "swagger" to your base URL.
Activating Swagger UI and Definitions
Swagger UI and definitions are disabled by default but can be enabled by an account administrator with access to OnTime Management Suite. For directions, see: Activating Swagger UI and Definitions for the OnTime REST API
You may acquire the current OnTime REST API Swagger definition (JSON formatted) through the following URL: