Shepherd Veterinary Software Reminder API

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

        {

        "embed": "client,patient",

        "rpp": 1

        }


        Example Response

        {

        "embed": "client,patient",

        "item": [

        {

        "client": {

        "dateDeleted": null,

        "deleted": false,

        "firstName": "Lena",

        "homeClinicId": "8d2a1b4f-3c7e-4f2d-9b6a-1c2d3e4f5a6b",

        "lastName": "Keller",

        "dateCreated": "2025-07-22T10:31:14.204Z",

        "dateUpdated": "2025-07-22T10:31:14.204Z",

        "id": "2f9b7c1e-5a44-49d7-9e6c-3f1d0b8a2c55"

        },

        "clientId": "2f9b7c1e-5a44-49d7-9e6c-3f1d0b8a2c55",

        "clinicId": "8d2a1b4f-3c7e-4f2d-9b6a-1c2d3e4f5a6b",

        "dateDue": "2025-09-01T00:00:00Z",

        "dateTriggered": "2025-08-04T12:47:03.118Z",

        "isCompleted": true,

        "isDeleted": false,

        "patient": {

        "dateDeceased": null,

        "dateDeleted": null,

        "dateOfBirth": "2021-11-15T00:00:00Z",

        "deleted": false,

        "homeClinicId": "8d2a1b4f-3c7e-4f2d-9b6a-1c2d3e4f5a6b",

        "identifier": "Q7HZ2PT",

        "name": "Milo",

        "dateCreated": "2025-07-30T08:09:52.731Z",

        "dateUpdated": "2025-07-30T08:10:11.264Z",

        "id": "a1c3f4e2-6b8d-4a59-9a0e-7f1b2c3d4e5f"

        },

        "patientId": "a1c3f4e2-6b8d-4a59-9a0e-7f1b2c3d4e5f",

        "reminderNotifications": [],

        "reminderSetting": null,

        "reminderSettingId": "5b2f1e9c-3d6a-4c8e-8b0f-91a2b3c4d5e6",

        "dateCreated": "2025-08-04T12:46:41.589Z",

        "dateUpdated": "2025-08-04T12:47:18.907Z",

        "id": "7d4a2b1c-9e8f-4f30-b7a6-2c1d0e9f8a65"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 1,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 2

        }'
      operationId: OpenApiReminderGet
      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 reminders matching the supplied filter. A filter that matches nothing returns an empty item array.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiReminderController.Reminder'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiReminderController.Reminder'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiReminderController.Reminder'
        '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/OpenApiReminderController.ReminderFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiReminderController.ReminderFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiReminderController.ReminderFilterModel'
        description: The model.
        required: true
components:
  schemas:
    OpenApiReminderController.ReminderNotification:
      description: ReminderNotification REST model
      type: object
      properties:
        clinicId:
          description: Unique identifier representing The related clinic entity.
          type: string
        dueDate:
          format: int32
          description: Time between reminder and it's notification.
          type: integer
        isBefore:
          description: Flag indicating whether this reminder notification will be sent before/after reminder's date.
          type: boolean
        sendDate:
          format: date-time
          description: Date when the notification will be sent.
          type: string
        timeUnit:
          $ref: '#/components/schemas/OpenApiReminderController.TimeUnit'
          description: Object representing the related Time unit entity.
        timeUnitId:
          description: Unique identifier representing the related Time unit entity.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiReminderController.Reminder:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiReminderController.Reminder'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiReminderController.Client:
      description: Client REST model.
      type: object
      properties:
        dateDeleted:
          format: date-time
          description: Date when the client record was deleted.
          type: string
        deleted:
          description: Flag indicating whether this client is deleted.
          type: boolean
        firstName:
          description: Client's first name.
          type: string
        homeClinicId:
          description: Unique identifier representing The client's home clinic.
          type: string
        lastName:
          description: Client's last name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiReminderController.Patient:
      description: Patient REST model.
      type: object
      properties:
        dateDeceased:
          format: date-time
          description: Date when the patient passed away.
          type: string
        dateDeleted:
          format: date-time
          description: Date when the patient record was deleted.
          type: string
        dateOfBirth:
          format: date-time
          description: Patient's date of birth.
          type: string
        deleted:
          description: Flag indicating whether this patient is deleted.
          type: boolean
        homeClinicId:
          description: Identifier of the clinic where the patient is registered.
          type: string
        identifier:
          description: Identifier (Patient ID on the patient profile).
          type: string
        name:
          description: Patient's name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiReminderController.ReminderFilterModel:
      description: Reminder Filter 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 or products.
          type: string
        dateDueFrom:
          format: date-time
          description: The start of the date range filter on the entity date due. Defaults to null.
          type: string
        dateDueTo:
          format: date-time
          description: The end of the date range filter on the entity date due. Defaults to null.
          type: string
        includePatientHomeClinic:
          description: "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Reminders from a patient's home clinic\nwhen filtering by clinic.\n            \nBehavior:\n- If true:\n  - Includes Reminders from the specified clinic (default)\n  - Also includes Reminders from other clinics where the patient's home clinic\n    matches the specified clinic\n- If false (default):\n  - Only includes Reminders 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
        isCompleted:
          description: Filters by completed status. Defaults to null (fetches both completed and non-completed reminder entities).
          type: boolean
        isDeleted:
          description: Filters by deleted status. Defaults to null (fetches both deleted and non-deleted reminder entities).
          type: boolean
        patientIds:
          description: Comma-separated string of Patient identifiers.
          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
    OpenApiReminderController.Reminder:
      description: Reminder REST model.
      type: object
      properties:
        client:
          $ref: '#/components/schemas/OpenApiReminderController.Client'
          description: Object representing the related Client entity.
        clientId:
          description: Unique identifier representing the related Client entity.
          type: string
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        dateDue:
          format: date-time
          description: Reminder's due date.
          type: string
        dateTriggered:
          format: date-time
          description: Date triggered.
          type: string
        isCompleted:
          description: Flag indicating whether this reminder is complete.
          type: boolean
        isDeleted:
          description: Flag indicating whether this reminder is deleted.
          type: boolean
        patient:
          $ref: '#/components/schemas/OpenApiReminderController.Patient'
          description: Object representing the related Patient entity.
        patientId:
          description: Unique identifier representing the related Patient entity.
          type: string
        reminderNotifications:
          description: List of objects representing the related reminder notifications.
          type: array
          items:
            $ref: '#/components/schemas/OpenApiReminderController.ReminderNotification'
        reminderSetting:
          $ref: '#/components/schemas/OpenApiReminderController.ReminderSetting'
          description: Object representing the related Reminder settting entity.
        reminderSettingId:
          description: Unique identifier representing the related Reminder setting entity.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiReminderController.TimeUnit:
      description: TimeUnit 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
    OpenApiReminderController.ReminderSetting:
      description: ReminderSetting REST model.
      type: object
      properties:
        autoCompleteProducts:
          description: 'List of objects representing the Automatic complete products. When a product from this list is administered it will automatically

            complete this reminder in the patient profile.'
          type: array
          items:
            $ref: '#/components/schemas/OpenApiReminderController.Product'
        clinicId:
          description: Unique identifier representing the related clinic entity.
          type: string
        dueDate:
          format: int32
          description: Number of days till ReminderSetting is due.
          type: integer
        isActive:
          description: Flag indicating whether this reminder setting is active.
          type: boolean
        isCustom:
          description: Flag indicating whether this reminder setting is custom.
          type: boolean
        isDeleted:
          description: Flag indicating whether this reminder setting is deleted.
          type: boolean
        name:
          description: Reminder setting name.
          type: string
        timeUnit:
          $ref: '#/components/schemas/OpenApiReminderController.TimeUnit'
          description: Object representing the related Time unit entity.
        timeUnitId:
          description: Unique identifier representing the related Time unit entity.
          type: string
        triggerProduct:
          $ref: '#/components/schemas/OpenApiReminderController.Product'
          description: 'Object representing the related TriggerProduct. When the trigger product is administered or added into an invoice, it ''triggers'' the reminder and

            assigns it to the patient with the due date determined by the default ''Due In'' setting.'
        triggerProductId:
          description: Unique identifier representing the related Trigger product entity.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiReminderController.Product:
      description: Product REST model.
      type: object
      properties:
        name:
          description: Product name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string