Skip to main content
The tipee API is versioned. The API version name is based on the date when the API version was released. For example, the API version 25.09.01 was released on Mon, 01 Sept 2025. You can select a version from the header to view the documentation for that specific version.

​
🔢 Selecting an API version

When issuing calls to the API, you must provide the version of the API you want using the Tipee-Version header. For example: 
Tipee-Version: 25.09.01
This header allows you to specify a date and ensures that the API will behave, in processing your request and in its response, (mostly) as it did on that date. Regarding the preview version, please refer to the penultimate paragraph ‘Preview’.

​
💥 Breaking changes

Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:
  • Removing an entire operation
  • Removing or renaming a parameter
  • Removing or renaming a response field
  • Adding a new required parameter
  • Making a previously optional parameter required
  • Changing the type of a parameter or response field
  • Removing enum values
  • Adding a new validation rule to an existing parameter
  • Changing authentication or authorization requirements
Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include:
  • Adding an operation
  • Adding an optional parameter
  • Adding an optional request header
  • Adding a response field
  • Adding a response header
  • Adding enum values

​
👁️ Preview version

This version endpoints should only be used for testing purposes and the Tipee-Version header is not necessary. Please note that this version endpoints might be in transition to be part of the latest version release and we cannot guarantee its validity or inform you of potential changes.

​
🔄 Deprecation and backward compatibility

When a new REST API version is released, the previous API version will be supported for at least 6 more months following the release of the new API version.