Overview
Polytomic's 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.
Docs
The documentation can be toggled between versions by selecting the version dropdown in the top left corner of the page
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' https://app.polytomic.com/api/me
All responses are returned with a X-Polytomic-Versionwhich denotes the version that responded to the request.
Supported versions
The currently supported versions are:
2023-04-252022-12-122021-05-23