Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.have-foresight.app/llms.txt

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

The current API is v1. Version is in the URL path: 
https://api.have-foresight.app/v1/...

​
Backward-compatible changes

These changes can land in v1 at any time without prior notice. Your client should handle them gracefully.
  • Adding new endpoints.
  • Adding new optional request fields.
  • Adding new fields to response bodies.
  • Adding new enum values to existing enums.
  • Adding new event types and webhook payloads.
  • Adding new error code values within an existing type.
  • Loosening validation rules.
  • Performance improvements that don’t change the wire format.
Implication for your code: treat unknown fields as harmless, do not fail on new enum values, and prefer switch with a default branch over exhaustive matches that throw.

​
Breaking changes

These never happen inside a major version. They require a new major version (v2) with at least 12 months of overlapping v1 support and deprecation notices through the dashboard, this site, and email.
  • Removing endpoints.
  • Removing or renaming fields.
  • Changing field types.
  • Removing enum values.
  • Tightening validation rules.
  • Changing default behavior of an existing endpoint.

​
Deprecation process

When a field, enum value, or endpoint is scheduled for removal:
  1. Marked deprecated in the reference docs and in the response Deprecation and Sunset headers per RFC 9745 and RFC 8594.
  2. At least 12 months runway before removal in the next major version.
  3. Email + dashboard notifications to every organization that called the deprecated surface in the last 30 days.
  4. Removal only in v2 (or later).
Example deprecation headers: 
Deprecation: @1764547200
Sunset: Wed, 01 Jul 2027 00:00:00 GMT
Link: <https://docs.have-foresight.app/api/claims/overview>; rel="deprecation"

​
Changelog

All non-trivial changes — additions, deprecations, security fixes — are recorded in the Changelog. Subscribe via RSS at https://docs.have-foresight.app/changelog/index/rss.xml.