Versioning

Overview

The Polytomic Connect API is versioned. Versions take the form of YYYY-MM-DD and are associated with the release date e.g. 2023-04-25. Any breaking changes will increment the version of the API. Existing versions will remain available for a period of time after.

By default, all requests will inherit version 2021-05-23 implicitly. However, the most recent and recommended version is 2023-04-25.

Specifying an API version

Use the X-Polytomic-Version request header to set the desired version . e.g. X-Polytomic-Version: 2023-04-25 when making requests.

For example:

$
curl --header "X-Polytomic-Version: 2023-04-25" --header "Authorization: Bearer ${POLYTOMIC_API_KEY}" https://app.polytomic.com/api/me

All responses are returned with a X-Polytomic-Version which denotes the version that responded to the request.

Supported Versions

The currently supported versions are:

• 2023-04-25
• 2022-12-12
• 2021-05-23