Versioning

Overview

The Polytomic Connect API is versioned. Version identifiers take the form YYYY-MM-DD and match the release date — for example, 2023-04-25. Breaking changes produce a new version. Older versions remain available for a period of time after a new release.

Requests that do not specify a version default to 2021-05-23. Set a version explicitly so new releases do not affect you.

Specifying an API version

Set the X-Polytomic-Version request header to the version you want — for example, X-Polytomic-Version: 2024-02-08.

$
curl --header "X-Polytomic-Version: 2024-02-08" \
>
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}" \
>
     https://app.polytomic.com/api/me

Every response includes an X-Polytomic-Version header indicating the version that served the request.

Supported versions

The currently supported versions are:

• 2024-02-08
• 2023-04-25
• 2022-12-12
• 2021-05-23