Shepherd Veterinary Software Client Note API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Client 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: ClientNote
paths:
  /pav2/open-api-client-notes:
    post:
      tags:
      - ClientNote
      summary: Retrieves {OpenApiClientNoteController.ClientNote} resources that match the…
      description: 'Example Request

        {

        "searchQuery": "Client"

        }


        Example Response

        {

        "embed": null,

        "item": [

        {

        "clientId": "97994a69-95e9-4d15-8171-b2f800c16d7b",

        "clinicId": "641d1862-762b-43ec-9abf-b2e300d32079",

        "createdByUser": null,

        "createdByUserId": "b6800547-f347-4e06-b7d2-b2b300f24f96",

        "editedByPav2User": null,

        "editedByUser": null,

        "editedByUserId": null,

        "isPinned": false,

        "note": "

        Client note 2

        ",

        "pav2User": null,

        "taggedUsersIds": null,

        "dateCreated": "2025-06-10T10:20:20.298197Z",

        "dateUpdated": "2025-06-10T10:20:20.506416Z",

        "id": "920cf7e3-ff02-4e78-9a8f-b2f800e1eeee"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 10,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 1

        }'
      operationId: OpenApiClientNoteGet
      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 client notes matching the supplied filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote'
        '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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiClientNoteController.ClientNoteFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiClientNoteController.ClientNoteFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiClientNoteController.ClientNoteFilterModel'
        description: The model.
        required: true
  /pav2/open-api-client-notes/write:
    post:
      tags:
      - ClientNote
      summary: Inserts a new {OpenApiClientNoteController.ClientNoteWriteModel}
      description: 'Example Request

        {

        "note": "Follow-up needed for rescheduling appointment",

        "clientId": "1ad410ea-2875-4feb-af21-b3a800ebae6e"

        }


        Example Response

        {

        "clientId": "1ad410ea-2875-4feb-af21-b3a800ebae6e",

        "clinicId": "a849337f-093a-4e51-82c8-b3a700f24345",

        "createdByUser": null,

        "createdByUserId": "d9c1a11f-5a91-4a0f-a809-b3f000aa8935",

        "editedByPav2User": null,

        "editedByUser": null,

        "editedByUserId": null,

        "isPinned": false,

        "note": "string",

        "pav2User": null,

        "taggedUsersIds": null,

        "dateCreated": "2026-02-13T08:22:14.3946808Z",

        "dateUpdated": "2026-02-13T08:22:14.3946808Z",

        "id": "ce31d98a-7944-4928-88b4-b3f000ab94fe"

        }'
      operationId: OpenApiClientNotePost
      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 client note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote'
        '400':
          description: 'One of: Client Id is missing. Note is missing. Request body missing, response body empty.'
        '404':
          description: The provided ClientId does not belong to the clinic.
        '409':
          description: The note could not be saved. The error describing the issue can be found in the response body.
        '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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiClientNoteController.ClientNoteWriteModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiClientNoteController.ClientNoteWriteModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiClientNoteController.ClientNoteWriteModel'
        required: true
components:
  schemas:
    OpenApiClientNoteController.Pav2User:
      description: Pav2User rest model.
      type: object
      properties:
        isDoctor:
          description: Value indicating whether this user is a doctor.
          type: boolean
        prefix:
          description: Prefix.
          type: string
        suffix:
          description: Suffix.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiClientNoteController.ClientNoteWriteModel:
      description: Client note for inserting REST model.
      type: object
      properties:
        clientId:
          format: uuid
          description: Unique identifier represeting the client to which the note belongs.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        note:
          description: Free-text field for Content of the note.
          type: string
    OpenApiClientNoteController.UserInfo:
      description: CoreUser REST model.
      type: object
      properties:
        firstName:
          description: User first name.
          type: string
        lastName:
          description: User last name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiClientNoteController.ClientNoteFilterModel:
      description: ClientNoteFilterModel REST model.
      type: object
      properties:
        clientIds:
          description: Comma-separated string of Client identifiers.
          type: string
        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.
          type: string
        searchQuery:
          description: Filters ClientNotes by Note's content.
          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
    OpenApiClientNoteController.ClientNote:
      description: ClientNote REST model.
      type: object
      properties:
        clientId:
          description: Unique identifier representing the client associated with the note.
          type: string
        clinicId:
          description: Unique identifier representing the clinic where the note was created.
          type: string
        createdByUser:
          $ref: '#/components/schemas/OpenApiClientNoteController.UserInfo'
          description: User who created the note.
        createdByUserId:
          description: Unique identifier representing the user who created the note.
          type: string
        editedByPav2User:
          $ref: '#/components/schemas/OpenApiClientNoteController.Pav2User'
          description: The PAV2 user associated with the most recent edit of the note.
        editedByUser:
          $ref: '#/components/schemas/OpenApiClientNoteController.UserInfo'
          description: The user associated with the most recent edit of the note.
        editedByUserId:
          description: Unique identifier representing the user who last edited the note.
          type: string
        isPinned:
          description: Value indicating whether this ClientNote is pinned.
          type: boolean
        note:
          description: HTML representation of the Note.
          type: string
        pav2User:
          $ref: '#/components/schemas/OpenApiClientNoteController.Pav2User'
          description: The PAV2 user who created the note.
        taggedUsersIds:
          description: The list of the tagged users ids.
          type: array
          items:
            type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiClientNoteController.ClientNote:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiClientNoteController.ClientNote'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer