Base URL

Protocol

The API is served over HTTP and HTTPS. We recommend you use HTTPS whenever possible.

Version

The current API version is 1.1. If you are using our older 1.0 version, please upgrade as soon as possible.

How RESTful?

We designed our API with RESTfulness in mind, but there are some notable exceptions:

PUT requests when modifying an existing resource is treated more like a PATCH request than a true PUT request.
This is because we found that a true PUT request is difficult to work with,
as the complete object graph must be sent with the request whenever an update is requested.
Our PUT requests on the other hand supports partial updates.

API Footprint

Although the API footprint is much wider than what's documented here, only what's documented is supported.
Anything that you discover that's outside of this documentation is subject to change without warning.
We will expand the supported API footprint on an ongoing basis and whenever we do, this documentation will be updated accordingly.