Docs Navigation

API Version

The API version is available via an endpoint. uses Semantic versioning for its API version numbers. Each version consists of three numbers, major.minor.patch, with this significance:

  • patch numbers are incremented for bug fixes, optimizations, or any other change that doesn’t change the API interface. You can usually ignore this part, unless you are looking for a particular bug fix.
  • minor numbers are for backward-compatible API changes. So all API functionality available in version 1.6.0 will also be available in version 1.7.0, but some new functionality will be available in 1.7.0 that’s not in 1.6.0. Code written for API version 1.6.0 should work as well, or better, with 1.7.0.
  • major numbers are for non-backwards-compatible API changes. Code written for version 1.6.0 will probably not work for version 2.1.0.


This retrieves the current version of the API.


The body of the request is empty. It does not require authentication.


The response is UTF-8-encoded JSON representing the version of the API currently deployed. It has two properties: name (which is always api) and version, which is a Semantic Version string for the version. For example:

 "name": "api", 
 "version": "0.7.0" 

Note: comparing semantic version numbers can be tricky; you should check for a semantic-version-parsing library for your programming language.