Frequently Asked Questions

General Questions

How do I perform delta loads? e.g. appointments in the last x hours:

Using the field comparators documented here, you can easily perform delta loads by setting the epoch time variable as the last time you synced.

https://api.trial.ezyvet.com/v2/appointment?modified_at={"gt":"1745107200"}

How can I raise API feature requests?

The ezyVet API operates under a WYSISYG framework and is constantly being improved which means some features that are available in the UI may not have API representation. Feature requests can be made by submitting a support ticket via the API Support email address. Whilst we will consider each request, we cannot guarentee each request will be fulfilled.

Authentication

How do I authenticate with the API?

Check out the API documentation here.

An example cURL:

curl    --location 'https://api.ezyvet.com/v1/oauth/access_token' \
        --header 'Content-Type: application/json' \
        --data '{
            "client_id": "string",
            "client_secret": "string",
            "partner_id": "string",
            "scope": "read-appointment",
            "grant_type": "client_credentials",
            "site_uid": "string"
        }'

How do I get the site_uid for an existing connection?

Take an existing ezyVet JWT access token and decode it using code.

WARNING

It's strongly encouraged to avoid using online tools such as https://www.jwt.io/ due to the sensitivity of the data being decoded.

Sample python code:

import jwt
import json

def decode_token(token: str):
    """
    :param token: jwt token
    :return:
    """
    decoded_data = jwt.decode(jwt=token,options={"verify_signature": False})
    print(json.dumps(decoded_data, indent=4))

token = input("Paste token here: ")
decode_token(token)

Example output of above code:

{
    "aud": "string",
    "jti": "string",
    "iat": 1765746831,
    "nbf": 1765746831,
    "exp": 1765790031,
    "sub": "string",
    "scopes": [
        "read-appointment",
        "write-appointment",
        "create-booking"
    ],
    "iss": "auth.ezyvet.com",
    "grp": "apisandbox",
    "url": "apisandbox.ezyvet.com",
    "site_uid": "site_jtv5H29i8pLkXi1wjWJQL",
    "zone": "usw2"
}

API Endpoints

What scope is required for each endpoint?

Category	Method	Endpoint	Scope(s)
Animal Management	POST	/v1/animal	write-animal
Animal Management	GET	/v1/animal	read-animal
Animal Management	PATCH	/v1/animal/{id}	write-animal
Animal Management	DELETE	/v1/animal/{id}	write-animal
Animal Management	GET	/v1.1/animal	read-animal
Animal Management	GET	/v1/animalcolour	read-animalcolour
Animal Management	GET	/v1/breed	read-breed
Animal Management	GET	/v1/sex	read-sex
Animal Management	GET	/v1/species	read-species
Animal Management	GET	/v2/animal	read-animal
Animal Management	GET	/v2.1/animal	read-animal
Animal Management	GET	/v4/animal	read-animal
Animal Management	GET	/v4/animal/{id}	read-animal
Appointment Management	GET	/v1/appointment	read-appointment
Appointment Management	GET	/v1/appointmentstatus	read-appointmentstatus
Appointment Management	GET	/v1/appointmenttype	read-appointmenttype
Appointment Management	GET	/v1/resource	read-resource
Appointment Management	POST	/v2/appointment	write-appointment
Appointment Management	GET	/v2/appointment	read-appointment
Appointment Management	PATCH	/v2/appointment/{id}	write-appointment
Appointment Management	GET	/v2/appointmenttype	read-appointmenttype
Appointment Management	GET	/v2/resource	read-resource
Appointment Management	GET	/ezycab/availability	read-appointment
Appointment Management	POST	/ezycab/booking	create-booking
Appointment Management	GET	/v2/shelteranimalbooking/{id}	read-shelteranimalbooking
Billing and Payments	GET	/v1/billingcredit	read-billingcredit
Billing and Payments	GET	/v1/invoice	read-invoice
Billing and Payments	GET	/v1/invoiceline	read-invoiceline
Billing and Payments	GET	/v1/payment	read-payment
Billing and Payments	GET	/v1/paymentmethod	read-paymentmethod
Billing and Payments	GET	/v1/priceadjustment	read-priceadjustment
Billing and Payments	GET	/v2/estimate	read-estimate
Billing and Payments	POST	/v2/invoice	write-invoice
Billing and Payments	GET	/v2/invoice	read-invoice
Billing and Payments	DELETE	/v2/invoice/{id}	write-invoice
Billing and Payments	PATCH	/v2/invoice/{id}	write-invoice
Billing and Payments	DELETE	/v2/invoiceline	write-invoiceline
Billing and Payments	PATCH	/v2/invoiceline	write-invoiceline
Billing and Payments	POST	/v2/invoiceline	write-invoiceline
Billing and Payments	GET	/v2/invoiceline	read-invoiceline
Billing and Payments	GET	/v2/ledgeraccount/{id}	read-ledgeraccount
Billing and Payments	GET	/v2/payment	read-payment
Billing and Payments	GET	/v2/taxrate	read-taxrate
Billing and Payments	GET	/v2/transaction	read-transaction
Clinical Management	GET	/v1/assessment	read-assessment
Clinical Management	POST	/v1/consult	write-consult
Clinical Management	GET	/v1/consult	read-consult
Clinical Management	PATCH	/v1/consult/{id}	write-consult
Clinical Management	DELETE	/v1/consult/{id}	write-consult
Clinical Management	GET	/v1/diagnostic	read-diagnostic
Clinical Management	POST	/v1/diagnosticrequest	write-diagnosticrequest
Clinical Management	DELETE	/v1/diagnosticrequest/{id}	write-diagnosticrequest
Clinical Management	PATCH	/v1/diagnosticrequest/{id}	write-diagnosticrequest
Clinical Management	GET	/v1/diagnosticrequest/{id}	read-diagnosticrequest
Clinical Management	POST	/v1/diagnosticresult	write-diagnosticresult
Clinical Management	GET	/v1/diagnosticresult	read-diagnosticresult
Clinical Management	DELETE	/v1/diagnosticresult/{id}	write-diagnosticresult
Clinical Management	PATCH	/v1/diagnosticresult/{id}	write-diagnosticresult
Clinical Management	POST	/v1/diagnosticresultitem	write-diagnosticresultitem
Clinical Management	GET	/v1/diagnosticresultitem	read-diagnosticresultitem
Clinical Management	PATCH	/v1/healthstatus	write-healthstatus
Clinical Management	GET	/v1/healthstatus	read-healthstatus
Clinical Management	POST	/v1/healthstatus	write-healthstatus
Clinical Management	DELETE	/v1/healthstatus/{id}	write-healthstatus
Clinical Management	GET	/v1/history	read-history
Clinical Management	GET	/v1/integrateddiagnostic	read-integrateddiagnostic
Clinical Management	GET	/v1/operation	read-operation
Clinical Management	POST	/v1/physicalexam	write-physicalexam
Clinical Management	GET	/v1/physicalexam	read-physicalexam
Clinical Management	PATCH	/v1/physicalexam/{id}	write-physicalexam
Clinical Management	GET	/v1/plan	read-plan
Clinical Management	GET	/v1/presentingproblem	read-presentingproblem
Clinical Management	GET	/v1/presentingproblemlink	read-presentingproblemlink
Clinical Management	GET	/v1/vaccination	read-vaccination
Clinical Management	POST	/v1/vaccination	write-vaccination
Clinical Management	PATCH	/v1/vaccination/{id}	write-vaccination
Clinical Management	GET	/v2/eventgroup	read-eventgroup
Clinical Management	GET	/v2/standardofcare	read-standardofcare
Contact Management	POST	/v1/address	write-address
Contact Management	GET	/v1/address	read-address
Contact Management	PATCH	/v1/address/{id}	write-address
Contact Management	DELETE	/v1/address/{id}	write-address
Contact Management	GET	/v2/communication	read-communication
Contact Management	POST	/v2/communication	write-communication
Contact Management	DELETE	/v2/communication/{id}	write-communication
Contact Management	PATCH	/v2/communication/{id}	write-communication
Contact Management	POST	/v4/communication/sentCommunication	write-communication
Contact Management	GET	/v1/contact	read-contact
Contact Management	POST	/v1/contact	write-contact
Contact Management	PATCH	/v1/contact/{id}	write-contact
Contact Management	DELETE	/v1/contact/{id}	write-contact
Contact Management	GET	/v1/contactassociation	read-contactassociation
Contact Management	GET	/v1/contactdetail	read-contactdetail
Contact Management	POST	/v1/contactdetail	write-contactdetail
Contact Management	PATCH	/v1/contactdetail/{id}	write-contactdetail
Contact Management	GET	/v1/contactdetailtype	read-contactdetailtype
Contact Management	GET	/v1/country	read-country
Contact Management	GET	/v2/contact	read-contact
Contact Management	POST	/v2/contactdetail	write-contactdetail
Contact Management	GET	/v2/contactdetail	read-contactdetail
Inventory Management	GET	/v1/barcode	read-barcode
Inventory Management	GET	/v1/product	read-product
Inventory Management	GET	/v1/productgroup	read-productgroup
Inventory Management	GET	/v1/purchaseorder	read-purchaseorder
Inventory Management	GET	/v1/purchaseorderitem	read-purchaseorderitem
Inventory Management	GET	/v1/receiveinvoice	read-receiveinvoice
Inventory Management	POST	/v1/receiveinvoice	write-receiveinvoice
Inventory Management	DELETE	/v1/receiveinvoice/{id}	write-receiveinvoice
Inventory Management	PATCH	/v1/receiveinvoice/{id}	write-receiveinvoice
Inventory Management	GET	/v1/receiveinvoiceitem	read-receiveinvoiceitem
Inventory Management	POST	/v1/receiveinvoiceitem	write-receiveinvoiceitem
Inventory Management	PATCH	/v1/receiveinvoiceitem/{id}	write-receiveinvoiceitem
Inventory Management	DELETE	/v1/receiveinvoiceitem/{id}	write-receiveinvoiceitem
Inventory Management	GET	/v2/batch	read-batch
Inventory Management	POST	/v2/batch	write-batch
Inventory Management	GET	/v2/product/{product_id}	read-product
Inventory Management	PATCH	/v2.1/product/servicefee/bulk	write-productpricing
Inventory Management	GET	/v2/productminimumstock	read-productminimumstock
Inventory Management	GET	/v2/productpricing	read-productpricing
Inventory Management	POST	/v2/productpricing	write-productpricing
Inventory Management	PATCH	/v2/productpricing/{id}	write-productpricing
Inventory Management	DELETE	/v2/productpricing/{id}	write-productpricing
Inventory Management	GET	/v2/productsupplier	read-productsupplier
Inventory Management	POST	/v2/receiveinvoice	write-receiveinvoice
Inventory Management	GET	/v2/receiveinvoice	read-receiveinvoice
Inventory Management	POST	/v2/receiveinvoiceitem	write-receiveinvoiceitem
Inventory Management	GET	/v2/receiveinvoiceitem	read-receiveinvoiceitem
Inventory Management	POST	/v2/stockadjustment	write-stockadjustment
Inventory Management	GET	/v2/stockadjustment/{id}	read-stockadjustment
Inventory Management	POST	/v2/stockadjustmentitem	write-stockadjustmentitem
Inventory Management	GET	/v2/stockadjustmentitem/{id}	read-stockadjustmentitem
Inventory Management	GET	/v2/stocktransaction	read-stocktransaction
Inventory Management	GET	/inventory/v1/products	inventory-management
Inventory Management	GET	/inventory/v1/requirements	inventory-management
Inventory Management	POST	/inventory/v1/supplied	inventory-management
Inventory Management	GET	/inventory/v2/balances	inventory-management
Inventory Management	POST	/v4/purchaseorder	practice-management
Prescription Management	PATCH	/v1/externalprescription	write-externalprescription
Prescription Management	POST	/v1/externalprescription	write-externalprescription
Prescription Management	DELETE	/v1/externalprescription	write-externalprescription
Prescription Management	POST	/v1/prescription	write-prescription
Prescription Management	GET	/v1/prescription	read-prescription
Prescription Management	PATCH	/v1/prescription/{id}	write-prescription
Prescription Management	DELETE	/v1/prescription/{id}	write-prescription
Prescription Management	GET	/v1/prescriptionitem	read-prescriptionitem
Prescription Management	POST	/v1/prescriptionitem	write-prescriptionitem
Prescription Management	PATCH	/v1/prescriptionitem/{id}	write-prescription
Prescription Management	DELETE	/v1/prescriptionitem/{id}	write-prescription
Prescription Management	GET	/v1/therapeutic	read-therapeutic
System Admin	GET	/v1/attachment	read-attachment
System Admin	POST	/v1/attachment	write-attachment
System Admin	GET	/v1/attachment/download/{id}	read-attachment
System Admin	PATCH	/v1/attachment/{id}	write-attachment
System Admin	DELETE	/v1/attachment/{id}	write-attachment
System Admin	POST	/v1/file	write-file
System Admin	GET	/v1/file/{id}	read-attachment
System Admin	GET	/v1/separation	read-separation
System Admin	GET	/v1/systemsetting	read-systemsetting
System Admin	GET	/v1/tag	read-tag
System Admin	GET	/v1/tagcategory	read-tagcategory
System Admin	GET	/v1/tagname	read-tagname
System Admin	GET	/v1/user	read-user
System Admin	GET	/v1/webhookevents	read-webhookevents
System Admin	GET	/v1/webhooks	read-webhooks
System Admin	POST	/v1/webhooks	write-webhook
System Admin	DELETE	/v1/webhooks/{id}	write-webhook
System Admin	PATCH	/v1/webhooks/{id}	write-webhook
System Admin	GET	/v2/separation	read-separation
System Admin	GET	/v2/separation/withprimaryinventorylocation	read-separation
System Admin	GET	/v3/siteInformation	read-systemsetting
System Admin	GET	/v4/user	user-management
System Admin	POST	/v4/user	user-management
System Admin	GET	/v4/user/{id}	user-management
System Admin	PATCH	/v4/user/{id}	user-management
System Admin	POST	/v4/user/bulk	user-management
System Admin	PATCH	/v4/user/bulk	user-management
System Admin	GET	/v4/role	user-management
Wellness Management	POST	/v2/wellnessplan	write-wellnessplan
Wellness Management	GET	/v2/wellnessplan	read-wellnessplan
Wellness Management	PATCH	/v2/wellnessplan/{id}	write-wellnessplan
Wellness Management	DELETE	/v2/wellnessplan/{id}	write-wellnessplan
Wellness Management	GET	/v2/wellnessplanbenefit	read-wellnessplanbenefit
Wellness Management	POST	/v2/wellnessplanbenefit	write-wellnessplanbenefit
Wellness Management	PATCH	/v2/wellnessplanbenefit/{id}	write-wellnessplan
Wellness Management	GET	/v2/wellnessplanbenefititem	read-wellnessplanbenefititem
Wellness Management	PATCH	/v2/wellnessplanmembership	write-wellnessplanmembership
Wellness Management	GET	/v2/wellnessplanmembership	read-wellnessplanmembership
Wellness Management	POST	/v2/wellnessplanmembership	write-wellnessplanmembership

Troubleshooting

Is an integration configured correctly?

• Are all scopes for the integration record enabled?
• Have you distributed the client_credentials.txt file to the appropriate contact?
• Are there any other steps required that are noted in the integration user guide?

INFO

All scopes for an integration record should be enabled to ensure proper functionality.

Why can I not access a sandbox/trial environment?

• Confirm your UI user credentials are correct.
• Confirm your API credentials are correct.
• Confirm your integration's scopes are all enabled.
• Confirm the site you're accessing is correct.
• Trial sites expire and will result in a 404 - Not found error when attempting to browse to it. Contact the Partnerships team for assistance.