Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt

Use this file to discover all available pages before exploring further.

Catena’s API provides clear stability guarantees. Stable endpoints maintain backward compatibility, while provisional endpoints allow us to iterate based on your feedback.

​
Endpoint Stability Levels

​
Stable Endpoints

Endpoints without the vial icon are considered stable and production-ready. These endpoints:
  • Maintain backward compatibility across minor and patch releases
  • Guarantee no breaking changes without a major version update
  • Receive full support, bug fixes, and maintenance
Use stable endpoints for production applications where reliability and predictability are critical.

​
Provisional Endpoints

Endpoints marked with the vial icon are provisional and may change based on customer feedback. These endpoints:
  • May introduce breaking changes in future releases without a major version bump
  • Allow us to iterate quickly on new features based on real-world usage
  • Receive advance notice of any breaking changes via our changelog
The core schema of provisional endpoints is stable, but minor details — such as field names or added fields — may change before it becomes generally available. Backward compatibility is not guaranteed. Use these endpoints when you want early access to new features and can adapt to changes.

​
Breaking Change Policy

​
For Stable Endpoints

When breaking changes are unavoidable for stable endpoints, we follow a multi-step deprecation process:

Deprecation Notice

Fields and endpoints are marked as deprecated in the API documentation and OpenAPI specification. We provide clear guidance on alternative solutions.

Telemetry Monitoring

We monitor API usage patterns via telemetry to understand impact and ensure customers have migrated to new alternatives before removal.

Changelog Communication

All deprecations and breaking changes are announced in our changelog and by email with migration timelines.

Major Version Release

Deprecated fields and endpoints are removed only in the next major version release (e.g., v2 → v3). The previous version continues to work but becomes unmaintained.

​
For Provisional Endpoints

Provisional endpoints may change with shorter notice, but we commit to:
  1. Monitoring usage via telemetry to understand impact before renaming, replacing, or removing endpoints
  2. Announcing breaking changes in the changelog and by email before they take effect
  3. Providing migration guidance when endpoints or field structures change
  4. Giving reasonable notice whenever possible to minimize disruption

​
Versioning Strategy

Our API uses semantic versioning with the format vMAJOR:
  • Major version (e.g., /v2/): Introduces breaking changes, removes deprecated features
  • Minor updates: Add new features, provisional endpoints, or non-breaking enhancements
  • Patch updates: Bug fixes and performance improvements
The current API version is v2. All endpoints are prefixed with /v2/ in the base URL: https://api.catenatelematics.com/v2/

​
Stay Informed

Track API changes, new features, and deprecation notices:
  • Changelog - Complete history of API updates and breaking changes
  • OpenAPI Specification - Review endpoint stability markers and detailed schemas
  • Support - Contact support@catenaclearing.io with questions about stability or migration