How do I use the AwareGO open API?

Learn more about how to use the API.

The AwareGO API is a RESTful interface, providing programmatic access to much of the data in the system. It provides predictable URLs for accessing resources and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate with a wide variety of environments and opens up endless opportunities for integration.

The API accepts JSON or form-encoded content in requests and returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.


The first step is to go to settings and get an API key.  You can find that in the menu under settings -> API keys. Then head over to our online API documentation and try it out in our interactive testing environment.