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://apiv2.ezyvet.com/oauth/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"
        }'

API Endpoints

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.