Skip to main content

​
Overview

Our API uses date-based versioning to ensure backward compatibility and provide clear migration paths as we evolve the platform. Each Auth Client is automatically configured with an API version, which determines the behavior and available features for your requests.

​
Version Headers

Every API response includes an X-API-Version header that indicates which version was used to process your request. This helps you track and debug version-specific behavior. 
X-API-Version: 2025-12-01.chucky
You can override the Auth Client’s default version by providing your own X-API-Version header in the request: 
curl https://api.example.com/v1/resource \
  -H "X-API-Version: 2025-12-01.chucky" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Default Behavior

When creating a new Auth Client, it will automatically be configured to use the latest stable API version. This ensures your integration starts with a reliable, production-ready version of the API.

​
Version Selection

Different API version documentations are accessible via the version selector in the top left corner of the documentation.

​
Currently available versions:

VersionValueDescription
chucky2025-12-01.chuckyInitial stable release
batman2025-12-16.batmanLatest release