Currently, the API uses a date-based parameter for versioning while remaining compatible with the legacy numeric versions.
The API supports the following two versioning mechanisms:
The recommended format is a date string, for example: version=2025-01-01.
All future API versions will only support the date-based format.
Legacy versions use numeric parameters, for example: v=1, v=2, v=3.
Legacy versions remain supported but are not recommended for new integrations.
| Version Parameter | Notes |
|---|---|
| (no equivalent) | v=1 |
| (no equivalent) | v=2 |
| version=2025-01-01 | Equivalent to v=3. Latest version. |
If no version parameter is specified in the request, the API will default to the latest version.