Shepherd Veterinary Software Patient Note API
The PatientNote API from Shepherd Veterinary Software — 4 operation(s) for patientnote.
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-patientnote-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) Patient Note 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: PatientNote
paths:
/pav2/open-api-patient-notes/bulk-export:
post:
tags:
- PatientNote
summary: Retrieves {OpenApiPatientNoteController.PatientNoteBulkExport}
description: 'Use this endpoint instead of `POST /pav2/open-api-patient-notes` when fetching data in bulk.
Example Request
{
"clinicIds": "641d1862-762b-43ec-9abf-b2e300d32079"
}
Example Response
{
"message": "Exporting job started successfully",
"dateCreated": "2025-06-27T07:32:29.7297039Z",
"dateUpdated": "2025-06-27T07:32:29.7297039Z",
"id": "f1df1796-b043-41ac-84b2-b30900aeb635"
}'
operationId: OpenApiPatientNoteBulkExport
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
- name: x-clinic-id
in: header
description: The clinic uuid identifier
required: true
schema:
type: string
responses:
'200':
description: The export job was queued. Poll bulk-result with the returned id for its status and download URL.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkExport'
text/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkExport'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkExport'
'401':
description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id 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.
'400':
description: "A date filter range is reversed. The response body is one of:\n \"DateCreated filter 'From' can't be later than 'To'.\" - dateCreatedFrom is after dateCreatedTo.\n \"DateUpdated filter 'From' can't be later than 'To'.\" - dateUpdatedFrom is after dateUpdatedTo."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteFilterModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteFilterModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteFilterModel'
description: The model.
required: true
/pav2/open-api-patient-notes:
post:
tags:
- PatientNote
summary: Retrieves {OpenApiPatientNoteController.PatientNote} resources that match the…
description: 'Restrictions:
- You must pass either ''Created'' or ''Updated'' filter with both sides of the range defined. Filter range is restricted to max 1 month.
- Up to 10 000 items can be read from this endpoint. First request that attemts to read 10 001st item will return an error.
- For fetching data in bulk (i.e. wider date ranges than 1 month or attempting to fetch items past 10k limit) please refer to `POST /pav2/open-api-patient-notes/bulk-export`.
Example Request
{
"embed": "createdByUser",
"clinicIds": "54a8c9ff-1bd5-4a38-8472-a7db009cf1a1",
"dateUpdatedFrom": "2025-10-07T13:39:22.725Z",
"dateUpdatedTo": "2025-10-07T13:39:22.725Z"
}
Example Response
{
"embed": null,
"item": [
{
"createdByUser": {
"firstName": "John",
"lastName": "Developer",
"dateCreated": "2025-01-01T00:00:00Z",
"dateUpdated": "2025-06-01T00:00:00Z",
"id": "bcd41234-9a87-4c3d-8321-dfce00ef1111"
},
"createdByUserId": "bcd41234-9a87-4c3d-8321-dfce00ef1111",
"editedByPav2User": null,
"editedByUser": null,
"editedByUserId": null,
"isDeleted": false,
"note": "Follow-up note for test patient",
"patientId": "993af2f3-56d4-4b42-90b4-a7db00fc77b4",
"title": "General Checkup",
"dateCreated": "2025-06-27T10:15:33.712Z",
"dateUpdated": "2025-06-27T10:15:33.712Z",
"id": "25a7b5cd-c0a9-4778-99b3-dfce00ef2222"
}
],
"links": [],
"page": 1,
"recordsPerPage": 10,
"searchQuery": null,
"sort": null,
"totalRecords": 1
}'
operationId: OpenApiPatientNoteGet
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
- name: x-clinic-id
in: header
description: The clinic uuid identifier
required: true
schema:
type: string
responses:
'200':
description: A paged collection of patient notes matching the supplied filter.
content:
application/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote'
text/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote'
application/hal+json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote'
'401':
description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id 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.
'400':
description: "A filter is outside the limits for this endpoint. The response body is one of:\n \"DateCreated filter 'From' can't be later than 'To'.\" - dateCreatedFrom is after dateCreatedTo.\n \"DateUpdated filter 'From' can't be later than 'To'.\" - dateUpdatedFrom is after dateUpdatedTo.\n \"Request must contain either DateCreated or DateUpdated filter parameters. Refer to 'bulk-export' endpoint for requested resource.\" - none of dateCreatedFrom, dateCreatedTo, dateUpdatedFrom or dateUpdatedTo was supplied.\n \"DateCreated filter must define values for both 'From' and 'To'. Refer to 'bulk-export' endpoint for requested resource.\" - only one of dateCreatedFrom and dateCreatedTo was supplied.\n \"DateUpdated filter must define values for both 'From' and 'To'. Refer to 'bulk-export' endpoint for requested resource.\" - only one of dateUpdatedFrom and dateUpdatedTo was supplied.\n \"Difference of DateCreated filter 'From' and 'To' can't be more than 1 month. Refer to 'bulk-export' endpoint for requested resource.\" - dateCreatedTo is more than one month after dateCreatedFrom.\n \"Difference of DateUpdated filter 'From' and 'To' can't be more than 1 month. Refer to 'bulk-export' endpoint for requested resource.\" - dateUpdatedTo is more than one month after dateUpdatedFrom.\n \"Unable to read more than 10000 through this endpoint. Refer to 'bulk-export' endpoint for requested resource.\" - page multiplied by rpp is over 10000 (rpp is capped at 1000 first).\n \"ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG\" - searchQuery is longer than 500 characters.\n \"ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES\" - searchQuery contains more than 10 search terms; each word counts as one term, and text in double quotes counts as one term."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteFilterModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteFilterModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteFilterModel'
description: The model.
required: true
/pav2/open-api-patient-notes/bulk-result:
post:
tags:
- PatientNote
summary: Retrieves {OpenApiPatientNoteController.PatientNoteBulkResult}
description: 'Important:
- This endpoint will return current status of the bulk export request.
- If the export request is finished, download url will be provided in the response (url expires in 1h).
- If the download url is expired you can obtain the new one by requesting this endpoint with the same export request id once again.
- Result will be available for 10 days after it was created.
Example Request
{
"id": "d9f73f3b-2b6a-489e-8c8a-e3f109ca0f55"
}
Example Response
{
"status": "Finished",
"url": "http:/shepherddev.s3.us-east-2.amazonaws.com/MediaVault/PAV2/OpenAPI/Export/PatientNote/",
"dateCreated": "2025-06-27T08:34:12.119384Z",
"dateUpdated": "2025-06-27T08:34:14.982177Z",
"id": "d9f73f3b-2b6a-489e-8c8a-e3f109ca0f55"
}'
operationId: OpenApiPatientNoteBulkResult
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
- name: x-clinic-id
in: header
description: The clinic uuid identifier
required: true
schema:
type: string
responses:
'200':
description: The export job's status, with a download URL once the export has finished.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkResult'
text/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkResult'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkResult'
'401':
description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id 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.
'400':
description: "The export cannot be returned. The response body is one of:\n \"Id is missing.\" - id is missing or the empty GUID.\n Error object with message \"The request is invalid.\" - no export exists with the given id.\n \"Download request '{id}' has expired.\" - the export has expired, or its file was created more than 10 days ago."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkResultReadModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkResultReadModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteBulkResultReadModel'
description: The model.
required: true
/pav2/open-api-patient-notes/write:
post:
tags:
- PatientNote
summary: Inserts a new {OpenApiPatientNoteController.PatientNoteWriteModel}
description: 'Example Request
{
"note": "Follow-up needed for recent surgery",
"patientId": "a27f4c3e-bf92-4aa7-912b-d8c9e2822c43",
"title": "Post-operative note"
}
Example Response
{
"createdByUser": null,
"createdByUserId": "f5c2b2b7-45e1-49c3-8e5c-4dd19fa50291",
"editedByPav2User": null,
"editedByUser": null,
"editedByUserId": null,
"isDeleted": false,
"note": "Follow-up needed for recent surgery",
"patientId": "a27f4c3e-bf92-4aa7-912b-d8c9e2822c43",
"title": "Post-operative note",
"dateCreated": "2025-06-27T09:55:31.221084Z",
"dateUpdated": "2025-06-27T09:55:31.221084Z",
"id": "e9a80c6f-a73b-4695-a6ef-4201e6d40302"
}'
operationId: OpenApiPatientNotePost
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
- name: x-clinic-id
in: header
description: The clinic uuid identifier
required: true
schema:
type: string
responses:
'201':
description: The created patient note.
content:
application/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote'
text/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote'
application/hal+json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote'
'401':
description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id 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.
'400':
description: "A validation rule failed. The response body is one of:\n An empty body - the request body is missing, or the note was not saved.\n The request is invalid., with modelState - note is missing or blank. modelState names the offending field.\n \"PatientId is required and cannot be empty.\" - patientId is missing or the empty GUID.\n \"The provided PatientId does not belong to the clinic.\" - patientId does not exist, is deleted, or is outside the caller's clinic."
'409':
description: '"PATIENT.EDIT.WARNING_MERGE_PATIENT" - the patient was merged into another patient or deleted while the request was being processed.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteWriteModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteWriteModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNoteWriteModel'
required: true
components:
schemas:
OpenApiPatientNoteController.PatientNoteFilterModel:
description: Patient note filter REST model.
type: object
properties:
clinicIds:
description: Comma-separated list of Clinic identifiers. Defaults to null. The filter is applicable only if the group to which the clinic belongs shares clients and patients. If provided only PatientNote data from filtered clinic will be returned (regardles of the x-clinic-id in header). If it remains null, data from all the clinics in the group will be returned.
type: string
includePatientHomeClinic:
description: "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Patient notes from a patient's home clinic\nwhen filtering by clinic.\n \nBehavior:\n- If true:\n - Includes Patient notes from the specified clinic (default)\n - Also includes notes from other clinics where the patient's home clinic\n matches the specified clinic\n- If false (default):\n - Only includes Patient notes directly from the specified clinic\n \nNote: The patient's home clinic is only considered if ClinicIds are provided\nin the filter; otherwise, all data from the group is returned."
type: boolean
isDeleted:
description: Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entites).
type: boolean
isLegacy:
description: Filters by legacy status. Defaults to null (fetches both legacy and non-legacy entities).
type: boolean
patientIds:
description: Comma-separated string of patient identifiers.
type: string
searchQuery:
description: Searches patient notes by content of the note.
type: string
titles:
description: Filters by Note Titles.
type: array
items:
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
OpenApiPatientNoteController.PatientNoteWriteModel:
description: Patient mote for inserting REST model
required:
- note
- patientId
type: object
properties:
note:
description: Free-text field for Content of the note.
type: string
patientId:
description: Unique identifier representing the patient to which the note belongs.
type: string
title:
description: The Note title. Defaults to an empty string.
type: string
OpenApiPatientNoteController.PatientNoteBulkExport:
description: Patient note bulk export REST model.
type: object
properties:
message:
description: Free-text field for the message about initiating export.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiPatientNoteController.PatientNoteBulkResult:
description: Patient note bulk result REST model.
type: object
properties:
status:
description: The status of export.
type: string
url:
description: Patient notes csv url to S3 bucket.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiPatientNoteController.PatientNoteBulkResultReadModel:
description: Patient note bulk result read REST model.
type: object
properties:
id:
description: The Export identifier.
type: string
OpenApiPatientNoteController.PatientNote:
description: Patient note REST model.
type: object
properties:
createdByUser:
$ref: '#/components/schemas/OpenApiPatientNoteController.UserInfo'
description: Object representing the user who created patient note.
createdByUserId:
format: uuid
description: Unique identifier representing the the user who created the patient note.
type: string
example: 00000000-0000-0000-0000-000000000000
editedByPav2User:
$ref: '#/components/schemas/OpenApiPatientNoteController.Pav2User'
description: Object representing The PAV2 user who edited patient note.
editedByUser:
$ref: '#/components/schemas/OpenApiPatientNoteController.UserInfo'
description: Object representing the Information about the PAV2 user who edited the patient note.
editedByUserId:
format: uuid
description: Unique identifier representing the user who edited the patient note.
type: string
example: 00000000-0000-0000-0000-000000000000
isDeleted:
description: Flag indicating whether this patient note is deleted.
type: boolean
note:
description: Free-text field for Content of the note.
type: string
patientId:
format: uuid
description: Unique identifier representing the patient to which the note belongs.
type: string
example: 00000000-0000-0000-0000-000000000000
title:
description: Note title.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiPatientNoteController.Pav2User:
description: Pav2User REST model.
type: object
properties:
isDoctor:
description: Flag indicating whether the user is a doctor.
type: boolean
prefix:
description: Prefix of the user.
type: string
suffix:
description: Suffix of the user.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiPatientNoteController.UserInfo:
description: UserInfo REST model.
type: object
properties:
firstName:
description: First name of the user who edited the patient note.
type: string
lastName:
description: Last name of the user who edited the patient note.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
RESTCollectionModelBase_OpenApiPatientNoteController.PatientNote:
type: object
properties:
embed:
type: string
item:
type: array
items:
$ref: '#/components/schemas/OpenApiPatientNoteController.PatientNote'
page:
format: int32
type: integer
recordsPerPage:
format: int32
type: integer
searchQuery:
type: string
sort:
type: string
totalRecords:
format: int32
type: integer