FAQ

Short answers to the questions we hear most, each linking to the page with the full story. This list grows as patterns emerge from developer questions.

How do I get API keys?

It depends who you are. Clinic accounts with the open API feature can generate keys themselves in Shepherd (Admin → Integrations). Integration partners get keys from the Shepherd product team during onboarding. See Authentication and, for partners, Integration onboarding.

How much does API access cost?

Open API access is $35 per clinic site, per month, billed to the practice that enables it. Reading these docs is free; the fee applies once a clinic turns the feature on and starts using keys. See Pricing & access for the full picture, including what’s required to get keys.

I’m a new clinic still onboarding. Can I build at the same time?

Yes. You can start exploring the API while you onboard, but the integration work runs on its own track: it doesn’t pause or extend your standard onboarding timeline, and you’re still expected to go live on your normal schedule. Talk to your account manager about timing. See Pricing & access.

Is there a sandbox?

Yes. Build and test against https://demo-open-api.shepherd.vet/pav2/. Integration partners get a demo clinic to work in; clinic accounts can request a sandbox if they want one separate from their live clinic.

Does the API support webhooks?

Not yet. The API is polling-based: pull changes on a schedule using date filters (see Conventions), and mind the rate limits.

How do I work with multi-location clients?

Many operators run several clinics as a group, which can share data across locations. Check whether an account is multi-site and handle shared records correctly: see Groups and multi-site.

What are the rate limits?

See Rate limits for the current per-minute and per-hour ceilings and how throttling is signaled.

How do I report a bug or request a feature?

Use the Contact page: it has the right email for your question, plus a feature-request form.