Shepherd Veterinary Software Clinic API
The Clinic API from Shepherd Veterinary Software — 1 operation(s) for clinic.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shepherd-vet:shepherd-vet-clinic-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: v1
title: Shepherd Open API (v2.248.0.39) Clinic API
description: 'Production Base URL: https://open-api.shepherd.vet/pav2/
Production App URL: https://app.shepherd.vet/
Production Documentation URL: https://app.shepherd.vet/swagger/
Sandbox Base URL: https://demo-open-api.shepherd.vet/pav2/
Sandbox App URL: https://demo.shepherd.vet/
Sandbox Documentation URL: https://demo.shepherd.vet/swagger
Authorization: The integration is authorized by providing two headers in the API call
X-Integration-Private-Key - this contains the private key from your credentials
X-Integration-Public-Key - this contains the public key from your credentials
Additionally, for all requests other than Clinic, the X-Clinic-Id header must be provided with the value of the clinic entity id for which you are running the API requests. You can get the entity id by calling the Clinic endpoint. If authorization fails, the request returns HTTP status 401 and the response body is one of the messages below. Missing X-Integration-Public-Key header - the public key header is absent from the request. Missing X-Integration-Private-Key header - the private key header is absent from the request. Missing X-Clinic-Id header - the clinic identifier header is absent, and the endpoint is clinic scoped. Incorrect API keys provided - both key headers were supplied, but the public key matches no integration, or the private key is not valid for that integration. Integration not enabled for the provided clinic - the key pair is valid, but the integration is not enabled and active for the clinic supplied in X-Clinic-Id. NEW: Each API call will count against your RPH and RPM limits. Once you exhaust those limits, requests will start returning HTTP status 429. The RPH is set to 12000 and RPM to 800 (subject to change). Where an endpoint supports searchQuery, a query longer than 500 characters may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG, and a query with more than 10 words may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES. NOTE: Since this API is WIP, we would be happy to hear any feedback and to implement additional filtering/sorting options etc. **Endpoints:
All endpoints are POST requests that accept JSON bodies. The common request properties for all endpoints are:**
rpp::int - The number of items to return per page. The max is 1000. Defaults to 10. page::int - The page number. Defaults to 1. sort::string - Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". All top-level properties should be sortable, only some nested-fields work and you should probably not use them until this API reaches production and we settle on which nested-field sortings we will support. Default depends on endpoint, usually "id|asc". embed::string - Comma-separated values for nested-fields you want to fetch (eg. "clientPhones,clientPhones.phoneType" on Client endpoint). If a specific embed is not requested, the response will contain either null or an empty array for that value. No default. dateCreatedFrom::date
dateCreatedTo::date
dateUpdatedFrom::date
dateUpdatedTo::date
- Date range filters for either the creation date or last update date. - You can pass in either one end or both of them. *
* Only the date filters listed on an endpoint''s request model are supported; sending another one, or a ''From'' later than its ''To'', returns HTTP status 400. The request responses will come back as a JSON object. The common response properties for all endpoints are:
embed::string - Lists the embed used in the request. This may sometimes be different from what you sent in, if in the future we add that some embeds get set automatically on certain endpoints
links::object[] - Always empty, a leftover from the internal framework we use on our web API. Will be removed in the future if possible so do not rely on this
page::int - Which page was fetched.'
servers:
- url: https://open-api.shepherd.vet
tags:
- name: Clinic
paths:
/pav2/open-api-clinics:
post:
tags:
- Clinic
summary: Retrieves {OpenApiClinicController.Clinic} resources that match the specified…
description: 'Example Request
{
"embed": "clinicAddress",
"ids": "5fa03907-c437-4a56-8cd6-b2bb00ac4232"
}
Example Response
{
"embed": "clinicAddress",
"item": [
{
"clinicAddress": {
"address1": "Seasame Street",
"address2": "",
"city": "75000",
"clinicId": "5fa03907-c437-4a56-8cd6-b2bb00ac4232",
"state": "",
"zipCode": "Austin",
"dateCreated": "2025-04-10T07:24:27.825755Z",
"dateUpdated": "2025-05-20T09:00:17.178856Z",
"id": "5fa03907-c437-4a56-8cd6-b2bb00ac4232"
},
"clinicSetting": null,
"email": "example@com",
"fax": "",
"groupId": "9efe9c03-da45-4001-9c25-b2bb00abca6f",
"info": "",
"name": "Clinic 1",
"phone": "0915459809",
"smsNumber": "",
"taxRate": 0,
"dateCreated": "2025-04-10T07:24:27.627669Z",
"dateUpdated": "2025-05-20T09:00:17.331985Z",
"id": "5fa03907-c437-4a56-8cd6-b2bb00ac4232"
}
],
"links": [],
"page": 1,
"recordsPerPage": 10,
"searchQuery": null,
"sort": null,
"totalRecords": 1
}'
operationId: OpenApiClinicGet
parameters:
- name: x-integration-public-key
in: header
description: Your public API key
required: true
schema:
type: string
- name: x-integration-private-key
in: header
description: Your private API key
required: true
schema:
type: string
responses:
'200':
description: A paged collection of clinics matching the search criteria.
content:
application/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClinicController.Clinic'
text/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClinicController.Clinic'
application/hal+json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClinicController.Clinic'
'400':
description: 'The given ids value is not a valid GUID. Example message: "Invalid GUID format: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."'
'401':
description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Incorrect API keys provided, or Integration not enabled for the provided clinic.'
'429':
description: Request rate limit exceeded. Please wait before making further requests. Returned once the integration passes its configured hourly or per-minute request allowance.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiClinicController.ClinicFilterModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiClinicController.ClinicFilterModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiClinicController.ClinicFilterModel'
description: The model.
required: true
components:
schemas:
OpenApiClinicController.Clinic:
description: Clinic REST model.
type: object
properties:
clinicAddress:
$ref: '#/components/schemas/OpenApiClinicController.ClinicAddress'
description: The related ClinicAddress entity.
clinicSetting:
$ref: '#/components/schemas/OpenApiClinicController.ClinicSetting'
description: The clinic setting, contains additional clinic info
email:
description: The clinic's email address.
type: string
fax:
description: The clinic's fax number.
type: string
groupId:
format: uuid
description: Unique identifier of the related Group entity.
type: string
example: 00000000-0000-0000-0000-000000000000
info:
description: The clinic additional information.
type: string
name:
description: The clinic name.
type: string
phone:
description: The clinic's phone number.
type: string
smsNumber:
description: The clinic's SMS number.
type: string
taxRate:
format: double
description: Represents the tax rate applied to the clinic's services.
type: number
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
RESTCollectionModelBase_OpenApiClinicController.Clinic:
type: object
properties:
embed:
type: string
item:
type: array
items:
$ref: '#/components/schemas/OpenApiClinicController.Clinic'
page:
format: int32
type: integer
recordsPerPage:
format: int32
type: integer
searchQuery:
type: string
sort:
type: string
totalRecords:
format: int32
type: integer
OpenApiClinicController.Currency:
description: Currency REST model
type: object
properties:
code:
description: The currency code, (e.g "USD")
type: string
currencyName:
description: The currency name.
type: string
description:
description: The currency description.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiClinicController.ClinicSetting:
description: Clinic Setting REST model, contains additional clinic info
type: object
properties:
clinicId:
description: Unique identifier of the related Clinic entity
type: string
country:
$ref: '#/components/schemas/OpenApiClinicController.Country'
description: Information of The country that the Clinic comes from.
currency:
$ref: '#/components/schemas/OpenApiClinicController.Currency'
description: The currency that the Clinic uses
isBoardingOverlapEnabled:
description: If this value is set to true, the clinic can have overlapping boardings. If set to false, the clinic cannot have overlapping boardings.
type: boolean
isInventoryEnabled:
description: Value indicating whether clinic has is inventory enabled.
type: boolean
isInventoryTrackingEnabled:
description: Value indicating whether clinic has inventory tracking enabled.
type: boolean
isScheduleTemplateEnabled:
description: Flag indicating whether clinic has schedule template enabled. If this flag is set to true, ScheduleTemplateAppointment endpoint can be used.
type: boolean
isTemplatesDefinedByDay:
description: Gets or sets a value indicating whether this instance is templates defined by day.
type: boolean
taxRateTypeId:
format: uuid
description: Unique identifier of the related TaxRateType entity.
type: string
example: 00000000-0000-0000-0000-000000000000
temperatureUnit:
$ref: '#/components/schemas/OpenApiClinicController.TemperatureUnit'
description: The temperature unit that is set as default for the Clinic.
timeZone:
description: The Clinic's time zone.
type: string
website:
description: The Clinic's website.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiClinicController.TemperatureUnit:
description: Temperature Unit REST model
type: object
properties:
abrv:
description: Short unique identifier for the lookup.
type: string
description:
description: The description of the lookup entry.
type: string
name:
description: The name of the lookup entry.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiClinicController.ClinicFilterModel:
description: ClinicFilter REST model.
type: object
properties:
groupId:
format: uuid
description: 'Returns only clinics belonging to the specified group. When provided, takes
precedence over the X-Group-Id header.'
type: string
example: 00000000-0000-0000-0000-000000000000
searchQuery:
description: Search query that filters by clinic name, info, email, phone, fax and sms number.
type: string
dateCreatedFrom:
format: date-time
description: 'Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or
the request returns 400. Defaults to null.'
type: string
dateCreatedTo:
format: date-time
description: The end of the date range filter on the entity creation date. Defaults to null.
type: string
dateUpdatedFrom:
format: date-time
description: 'The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the
request returns 400. Defaults to null.'
type: string
dateUpdatedTo:
format: date-time
description: The end of the date range filter on the entity last update date. Defaults to null.
type: string
embed:
description: Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., "client.clientPhones"). Defaults to null.
type: string
excludeIds:
description: Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.
type: string
ids:
description: Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.
type: string
page:
format: int32
description: The page number. Defaults to 1.
type: integer
rpp:
format: int32
description: The number of items to return per page. The max is 1000. Defaults to 10.
type: integer
sort:
description: Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". The default sort field depends on the endpoint, typically "id|asc"
type: string
OpenApiClinicController.ClinicAddress:
description: ClinicAddress REST model.
type: object
properties:
address1:
description: Address Line 1 should include the most essential details to identify a location clearly (e.g. street and number).
type: string
address2:
description: Address Line 2 should be used to capture additional information that doesn't fit into Address Line 1. This line is essential for adding specific details to ensure accurate delivery or location identification (e.g. apt Apt 12C).
type: string
city:
description: Name of the city where the clinic is located.
type: string
clinicId:
description: Unique identifier of the clinic associated with this address.
type: string
state:
description: Name of the state, province, or region.
type: string
zipCode:
description: ZIP or postal code of the clinic's location.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiClinicController.Country:
description: Country REST model
type: object
properties:
abrv:
description: Short unique identifier for the lookup.
type: string
description:
description: The description of the lookup entry.
type: string
name:
description: The name of the lookup entry.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string