HomeGuidesAPI Reference
Log In

API Versioning

The Arc API uses a dated version scheme (YYYY-MM-DD), where a new version is released when one or more breaking changes are made to the API. We prioritize backward compatibility, so these breaking changes should not impact existing integrations. This also means that new functionality is often available to old API versions, although we still recommend staying up to date.

Every API request must specify the desired version through the Arc-Version header. For example - Arc-Version: 2021-11-17. Every response will include the version used in the Arc-Version header. After August 31 2022, API requests that do not provide a valid Arc-Version header will return an error with HTTP status 400.

New versions of the API and their breaking changes will be documented in the Changelog, which is also available as an RSS feed.

Backwards Compatibility

Arcadia considers the following changes to be backwards-compatible:

  • Adding new, optional parameters for existing endpoints
  • Adding new API endpoints
  • Adding new webhook event types
  • Adding new properties to an existing API response schema
  • Changing error_codes to be more specific for errors that cannot be resolved by the developer consuming the Arc API (for example, changing a 500 error code to a 504 error code)