Versioned API
What it does
POTAL API uses URL-based versioning (/api/v1/) to ensure backward compatibility. Breaking changes are introduced in new versions only, while existing versions continue to work. Deprecation notices are communicated via headers and changelog.
How to use it
Use the latest version
All current endpoints are under /api/v1/. Include the version prefix in all requests.
Check deprecation headers
Responses may include X-API-Deprecated and Sunset headers for endpoints scheduled for removal.
Follow the changelog
Subscribe to the API changelog for advance notice of new versions and deprecations.
Migrate gradually
When a new version launches, both old and new versions run in parallel for at least 6 months.
Related Features
155+ API endpoints with consistent JSON responses
Detailed changelog for every API version and breaking change
Step-by-step guides for migrating from competitor platforms
Interactive API docs with code examples in 5 languages
Full OpenAPI 3.0 specification for automated client generation