Veterical API reference

List appointments

List appointments for the API key's clinic, optionally filtered by clientId, patientId or a startTime/endTime window. Requires the appointments:read scope.

Create or update an appointment

Create an appointment in the API key's clinic. Requires the appointments:write scope.

Get an appointment by id

Fetch a single appointment owned by the API key's clinic. Requires the appointments:read scope. Returns 404 for an appointment outside the key's clinic or organization so ids cannot be probed.

List clients

List the pet owners (clients) of the API key's clinic. Requires the clients:read scope.

Create or update a client

Create a pet owner in the API key's clinic. Requires the clients:write scope.

Get a client by id

Fetch a single client owned by the API key's clinic. Requires the clients:read scope. Returns 404 for a client outside the key's clinic or organization so ids cannot be probed.

List invoices

List invoices for the API key's clinic, optionally filtered by patientId. Requires the invoices:read scope.

Create or update an invoice

Create an invoice in the API key's clinic. Requires the invoices:write scope.

Get an invoice by id

Fetch a single invoice owned by the API key's clinic. Requires the invoices:read scope. Returns 404 for an invoice outside the key's clinic or organization so ids cannot be probed.

List patients

List the patients (animals) of the API key's clinic. Requires the patients:read scope.

Create or update a patient

Create a patient (animal) in the API key's clinic. Requires the patients:write scope.

Get a patient by id

Fetch a single patient owned by the API key's clinic. Requires the patients:read scope. Returns 404 for a patient outside the key's clinic or organization so ids cannot be probed.

List payments

List payments for the API key's clinic, optionally filtered by patientId. Requires the payments:read scope.

Create or update a payment

Record a payment in the API key's clinic. Requires the payments:write scope.

Get a payment by id

Fetch a single payment owned by the API key's clinic. Requires the payments:read scope. Returns 404 for a payment outside the key's clinic or organization so ids cannot be probed.

List vaccinations

List vaccination records for the API key's clinic, optionally filtered by clientId, patientId or appointmentId. These records drive recall reminders. Requires the vaccinations:read scope.

Create or update a vaccination

Record a vaccination in the API key's clinic. Requires the vaccinations:write scope.

Get a vaccination by id

Fetch a single vaccination record owned by the API key's clinic. Requires the vaccinations:read scope. Returns 404 for a record outside the key's clinic or organization so ids cannot be probed.

List webhook subscriptions

Webhook subscriptions deliver client.created, patient.created, appointment.created, appointment.updated, invoice.created, payment.created and vaccination.created events (among others) to your server as signed POST requests (X-Veterical-Signature: t=<timestamp>,v1=<hex HMAC-SHA256 of "timestamp.body">). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the secret is only returned once, on create.

Create a webhook subscription

The response includes the signing secret exactly once — store it; it cannot be retrieved again. A subscription is scoped to a single clinicId.

Update a webhook subscription

url, events and active are editable; the secret and clinic are immutable. Re-enabling an auto-disabled endpoint is done by setting active back to true.

Delete a webhook subscription