Versioning & Deprecation

The current API is /v1. All endpoints documented here are part of that single version — there is no per-endpoint versioning.

How we'll ship /v2

  • /v1 keeps working exactly as documented for as long as it's supported — new fields are additive and optional; existing fields never change type or meaning.
  • Breaking changes (renamed/removed fields, changed semantics) ship under a new /v2 prefix, running side-by-side with /v1.
  • /v1 gets a minimum notice period before deprecation once /v2 is generally available, announced on this Changelog and via email to active API customers.
  • New endpoint families (Corporate, Litigation, Audit, Contracts) are additive to /v1 and do not require a version bump.

What counts as a non-breaking change

  • Adding a new optional request field.
  • Adding a new field to a response object.
  • Adding a new endpoint or endpoint family.
  • Adding a new enum value to a field that documents itself as open-ended (e.g. new tool_type values).