Skip to main content
The current API version is v1 and appears in every endpoint path.

​
v1 compatibility policy

Within v1, Hobbes may:
  • Add response fields
  • Add enum-like string values
  • Add optional query parameters
  • Add endpoints
  • Improve descriptions and examples
Within v1, Hobbes will not remove or rename existing fields or change their meaning without a migration path.

​
Build defensively

  • Ignore response fields your integration does not recognize.
  • Treat documented status values as open string sets unless the schema marks them as closed enums.
  • Handle nullable fields explicitly.
  • Use resource ids for idempotent upserts.
  • Pin business logic to the values you need instead of rejecting the entire response when a new value appears.

​
OpenAPI snapshot

The API reference is generated from a reviewed OpenAPI snapshot. The live engineering schema remains available at:
The public documentation snapshot is refreshed and reviewed whenever the external contract changes.