Skip to main content

​
The contract

The API is versioned in the URL path: /api/v1/…. As long as you stay on v1, we guarantee:
  • We won’t remove endpoints.
  • We won’t remove or rename existing response fields.
  • We won’t change the type of an existing field.
  • We won’t tighten validation in a way that rejects requests that worked before.
We will add things — new endpoints, new optional fields on responses, new optional query parameters. Your client should ignore unknown fields.

​
When we cut v2

If we ever need a breaking change, we publish it on /api/v2. v1 stays online for at least six months after v2 ships, with deprecation warnings in the Sunset response header and an email to every account that has made a v1 call in the previous 30 days.

​
Beta endpoints

Endpoints we want feedback on before promoting to stable live under /api/v1/… paths but are marked Beta in the API reference. Beta endpoints may change shape; pin to a specific date or watch the changelog if you depend on them.

​
Changelog

The changelog lives at docs.sitevisit.app/changelog (coming soon). For now, subscribe to release notes by emailing dev@sitevisit.app.