Skip to main content

Vetrics API

Versioning and changelog

The path stays /api/v1. Breaking changes wait for an explicit /api/v2. A patch release corrects documentation. A minor release adds a field, schema, or operation. Removals are announced in this changelog before they happen.

This site documents released contract 1.7.0. The generator on the hub may know a newer CLINIC_API_CONTRACT_VERSION (1.9.0 on this deployment). Operations introduced after the released version are omitted here until the released constant moves, which happens only after that version is on clinic production.

A clinic's own GET /api/v1/openapi.json describes the contract that clinic is running. It requires an API key. Use that file when you need the exact operations deployed at one clinic.

Changelog

  • 1.7.0 (2026-10-23, minor) — Practice profile, phone client lookup, diary availability slots, and staff working windows for receptionist integrations. Existing client and patient reads are limited to the API key's practice.
  • 1.6.0 (2026-10-16, minor) — Add clinician, patient, and client display fields on appointments, and PUT /api/v1/appointments/{id}/soap for a draft on a consultation that is already in progress.
  • 1.5.0 (2026-10-09, minor) — Send a prepared estimate email (estimates:issue) and send a reminder message now (reminders:write). Neither records a staff user as the sender.
  • 1.4.0 (2026-10-09, minor) — Workflow writes: ordinary invoice finalise, ordinary goods-receipt post, procurement submit, vaccination billing, inventory movements, treatment charges, and consented messages.
  • 1.3.0 (2026-10-09, minor) — Draft writes attributed to the integration: vitals, labs, problems, procedures, allergies, diagnoses, anaesthesia drafts, consent drafts, tasks, catalogue inventory, draft estimates, and vaccination records without billing.
  • 1.2.0 (2026-10-09, minor) — Practice-scoped reads for consultations, clinical records, invoice lines, payments, estimates, pet plans, procurement, the controlled-drug register, document bytes, and communications.
  • 1.1.0 (2026-10-09, minor) — Add opt-in SOAP note read and replace on GET/PUT /api/v1/consultations/{id}/soap (soap:read, soap:write). Draft notes on an in-progress consultation only.
  • 1.0.0 (2026-07-26, minor) — Publish executable clinic catalogue: OpenAPI from CLINIC_API_RESOURCES, field descriptions, webhook registry, and /api-docs generated from the same contract.