Skip to main content

API Lifecycle


API Versioning

Our API endpoints are versioned and typically structured in the following format:


where <VERSION> is the version number of the API (example: v1).

The API may receive non-breaking changes without its version number being changed.

Breaking changes are introduced only to new API versions.

Non-breaking changes can include (but are not limited to):

  • Adding new optional request headers
  • Adding new fields to the response
  • Adding new status codes to the response status codes list
  • Changing a required field to be optional
  • Changes to rate limits
  • Under-the-hood fixes that don’t change the URL signature, the request format or the response format

Breaking changes can include (but are not limited to):

  • Changing the URL signature
  • Removing a field from the response
  • Adding a new required field to the request

Deprecation Policy

If a newer version of the API is released or if the service is discontinued, the API or one of its versions may be deprecated and eventually shutdown. When deprecating an API, Unity will update the documentation in this portal by indicating deprecated routes and providing alternative solutions for the deprecated endpoints.

After three months to a year of continued support for a deprecated version, Unity may cease support or shutdown that version entirely. A version shutdown notice will be posted in this portal at least 2 months in advance.