Shepherd Veterinary Software Task Note API
The TaskNote API from Shepherd Veterinary Software — 3 operation(s) for tasknote.
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-tasknote-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) Task 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: TaskNote
paths:
/pav2/open-api-task-notes:
post:
tags:
- TaskNote
summary: Asynchronously retrieves {OpenApiTaskNoteController.TaskNote} resources that…
description: 'Example Request
{
"embed": "createdByUser"
}
Example Response
{
"embed": "createdByUser",
"item": [
{
"createdByUser": {
"firstName": "Emily",
"isDoctor": false,
"lastName": "Thompson",
"prefix": null,
"suffix": null,
"dateCreated": "2023-11-15T08:14:22.000000Z",
"dateUpdated": "2025-06-01T13:59:00.000000Z",
"id": "ab7c2d18-3ef4-4a6c-9357-2bd1d9f9ac91"
},
"createdByUserId": "ab7c2d18-3ef4-4a6c-9357-2bd1d9f9ac91",
"editedByUser": null,
"editedByUserId": null,
"note": "
Follow-up scheduled for next visit.
",
"taskEntryId": "d5a3c289-e85e-4976-82c2-38df1fa264e7",
"dateCreated": "2025-08-06T06:38:08.209944Z",
"dateUpdated": "2025-08-06T06:38:08.258996Z",
"id": "ee21a714-3f25-4bfa-a9c3-9a00176ce147"
}
],
"links": [],
"page": 1,
"recordsPerPage": 10,
"searchQuery": null,
"sort": null,
"totalRecords": 1
}'
operationId: TaskNoteGetBySearchCriteria
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 task notes matching the supplied filter.
content:
application/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiTaskNoteController.TaskNote'
text/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiTaskNoteController.TaskNote'
application/hal+json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiTaskNoteController.TaskNote'
'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: 'No envelope - the body is the message itself, as a JSON string:
ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG - searchQuery is longer than 500 characters.
ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES - searchQuery has more than 10 words.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteFilterModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteFilterModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteFilterModel'
description: The model.
required: true
/pav2/open-api-task-notes/write:
post:
tags:
- TaskNote
summary: Asynchronously inserts new {OpenApiTaskNoteController.TaskNoteWriteModel}…
description: 'Example Request
{
"note": "Very important task",
"taskEntryId": "1c309571-c631-4c3e-b901-b331009dfa91"
}
Example Response
{
"createdByUser": null,
"createdByUserId": "d3f7c4a2-89e1-47bd-9187-31a5f0b6a901",
"editedByUser": null,
"editedByUserId": null,
"note": "Very important task",
"taskEntryId": "1c309571-c631-4c3e-b901-b331009dfa91",
"dateCreated": "2025-08-06T06:41:04.6727249Z",
"dateUpdated": "2025-08-06T06:41:04.6727249Z",
"id": "7a8b9c01-234f-4e98-8b12-45cd671ef38d"
}'
operationId: TaskNotePost
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 task note.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNote'
text/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNote'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNote'
'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 request is invalid." with one modelState entry per missing field; a blank note counts as missing:
The Note field is required.
The TaskEntryId field is required.
"The request is invalid." without modelState:
The request is invalid. - taskEntryId is not a GUID.
No envelope - the body is the message itself, as a JSON string:
TaskEntryId is required and cannot be empty. - taskEntryId was sent as 00000000-0000-0000-0000-000000000000.
The provided TaskEntryId does not belong to the clinic.
Empty response body:
The request has no body at all.'
'409':
description: The task note was not inserted. The response body is empty.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteWriteModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteWriteModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteWriteModel'
description: The model.
required: true
/pav2/open-api-task-notes/update/{id}:
put:
tags:
- TaskNote
summary: Asynchronously updates previously created…
description: 'Example Request
{
"note": "Updated Note"
}'
operationId: TaskNotePut
parameters:
- name: id
in: path
description: TaskNote id which uniquely identifies {Baasic.Module.PAV2.OpenAPI.Controllers.OpenApiTaskNoteController.TaskNoteUpdateModel} resource that needs to be updated.
required: true
schema:
type: string
format: uuid
- 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:
'204':
description: The task note was updated. The response body is empty.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
application/hal+json:
schema:
type: object
'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 request is invalid." with one modelState entry for id:
The value ''{id}'' is not valid for Guid. - the id route value is not a GUID.
Empty response body:
The id route value is 00000000-0000-0000-0000-000000000000, or the request has no body at all; an empty {} body is accepted.'
'404':
description: No task note with the supplied id exists in the caller's clinic, or in the caller's clinic group when the group shares tasks. The response body is empty.
'409':
description: The update was not applied. The response body is empty.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteUpdateModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteUpdateModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNoteUpdateModel'
description: The model.
required: true
components:
schemas:
OpenApiTaskNoteController.TaskNoteUpdateModel:
description: TaskNote to update REST model.
type: object
properties:
note:
description: Free-Text field for this Note.
type: string
OpenApiTaskNoteController.TaskNoteFilterModel:
description: TaskNote filter REST model.
type: object
properties:
clinicIds:
description: Comma-separated list of clinic identifiers. The filter is applicable only if the group to which the clinic belongs shares clients and patients.
type: string
searchQuery:
description: Filters notes by their text content.
type: string
taskEntryId:
description: Filters by task entry identifier.
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
RESTCollectionModelBase_OpenApiTaskNoteController.TaskNote:
type: object
properties:
embed:
type: string
item:
type: array
items:
$ref: '#/components/schemas/OpenApiTaskNoteController.TaskNote'
page:
format: int32
type: integer
recordsPerPage:
format: int32
type: integer
searchQuery:
type: string
sort:
type: string
totalRecords:
format: int32
type: integer
OpenApiTaskNoteController.TaskNote:
description: TaskNote REST model.
required:
- note
type: object
properties:
createdByUser:
$ref: '#/components/schemas/OpenApiTaskNoteController.UserInfo'
description: Object representing the UserInfo of the user who created this note.
createdByUserId:
format: uuid
description: Unique Identifier of the user who created this note.
type: string
example: 00000000-0000-0000-0000-000000000000
editedByUser:
$ref: '#/components/schemas/OpenApiTaskNoteController.UserInfo'
description: Object representing the UserInfo of the user who edited this note.
editedByUserId:
format: uuid
description: Unique Identifier of the user who edited this note.
type: string
example: 00000000-0000-0000-0000-000000000000
note:
description: Free-Text field for this Note.
type: string
taskEntryId:
format: uuid
description: Unique identifier representing the related Task entry entity.
type: string
example: 00000000-0000-0000-0000-000000000000
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiTaskNoteController.UserInfo:
description: UserInfo REST model.
type: object
properties:
firstName:
description: User's first name.
type: string
isDoctor:
description: Flag indicating whether this user is doctor.
type: boolean
lastName:
description: User's last name.
type: string
prefix:
description: User's assigned prefix (e.g., "Dr.", "Mr.", "Mrs.").
type: string
suffix:
description: User's assigned suffix (e.g., "MD", "PhD", "Jr.").
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiTaskNoteController.TaskNoteWriteModel:
description: TaskNote to write REST model.
required:
- note
- taskEntryId
type: object
properties:
note:
description: Free-Text field for this Note.
type: string
taskEntryId:
description: Unique identifier representing the related Task entry entity.
type: string