Shepherd Veterinary Software Reminder Setting API

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

        {

        "rpp": 1,

        "isCustom": true

        }


        Example Response

        {

        "embed": null,

        "item": [

        {

        "autoCompleteProducts": [],

        "clinicId": "5c2f8a7b-1d3e-4b9a-92f0-7e6d5c4b3a21",

        "dueDate": 0,

        "isActive": true,

        "isCustom": true,

        "isDeleted": false,

        "name": "Reminder Alpha",

        "reminderNotificationSettings": [],

        "timeUnit": null,

        "timeUnitId": null,

        "triggerProduct": null,

        "triggerProductId": null,

        "dateCreated": "2025-08-04T12:20:11.482Z",

        "dateUpdated": "2025-08-04T12:21:03.917Z",

        "id": "b3a1c2d4-5e6f-47a9-8b0c-1d2e3f4a5b6c"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 1,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 2

        }'
      operationId: OpenApiReminderSettingGet
      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 reminder settings matching the supplied filter. A filter that matches nothing returns an empty item array.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiReminderSettingController.ReminderSetting'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiReminderSettingController.ReminderSetting'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiReminderSettingController.ReminderSetting'
        '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/OpenApiReminderSettingController.ReminderSettingFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiReminderSettingController.ReminderSettingFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiReminderSettingController.ReminderSettingFilterModel'
        description: The model.
        required: true
components:
  schemas:
    OpenApiReminderSettingController.Product:
      description: Product REST model.
      type: object
      properties:
        name:
          description: Display name of the product.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiReminderSettingController.ReminderSetting:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiReminderSettingController.ReminderSetting'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiReminderSettingController.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
    OpenApiReminderNotificationSettingController.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
    OpenApiReminderNotificationSettingController.ReminderNotificationSetting:
      description: ReminderNotificationSetting REST model.
      type: object
      properties:
        clinicId:
          format: uuid
          description: Unique identifier representing the related Clinic entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dueDate:
          format: int32
          description: 'The numeric value of the time interval between the reminder''s due date and when the notification is sent (e.g. 30).

            The exact time of sending depends on the {Baasic.Module.PAV2.OpenAPI.Controllers.OpenApiReminderNotificationSettingController.ReminderNotificationSetting.IsBefore} property.'
          type: integer
        isBefore:
          description: Flag indicating whether this reminder notification will be sent before/after reminder's date. If true, the notification is sent before the reminder's due date; if false, it is sent after.
          type: boolean
        reminderSettingId:
          format: uuid
          description: Unique identifier representing the related reminder configuration.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        timeUnit:
          $ref: '#/components/schemas/OpenApiReminderNotificationSettingController.TimeUnit'
          description: The measurement unit that defines the interval for when a notification is sent relative to the reminder's due date. (e.g. day(s), week(s), month(s), year(s))
        timeUnitId:
          format: uuid
          description: Unique identifier representing the related time unit entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiReminderSettingController.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/OpenApiReminderSettingController.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
        referenceNumber:
          description: 'A unique reference number automatically generated by the system.

            The value is unique within the group scope.

            Reference numbers from deleted entities may be reassigned to newly created entities.'
          type: string
        reminderNotificationSettings:
          description: List representing the related ReminderNotificationSetting objects.
          type: array
          items:
            $ref: '#/components/schemas/OpenApiReminderNotificationSettingController.ReminderNotificationSetting'
        reminderTriggerProducts:
          description: List representing the related ReminderTriggerProducts objects.
          type: array
          items:
            $ref: '#/components/schemas/OpenApiReminderSettingController.ReminderTriggerProduct'
        timeUnit:
          $ref: '#/components/schemas/OpenApiReminderSettingController.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/OpenApiReminderSettingController.Product'
          description: 'This field is obsolete and has been replaced by ReminderTriggerProducts.

            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: 'This field is obsolete and has been replaced by ProductId field from ReminderTriggerProducts.

            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
    OpenApiReminderSettingController.ReminderSettingFilterModel:
      description: Reminder Setting 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 products.
          type: string
        isCustom:
          description: Filters by IsCustom status. Defaults to null (fetches both custom and non-custom entities).
          type: boolean
        isDeleted:
          description: Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).
          type: boolean
        searchQuery:
          description: Filters by reminder setting name.
          type: string
        triggerProductIds:
          description: Comma-separated list of related Product entity unique identifiers. Defaults to null.
          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
    OpenApiReminderSettingController.ReminderTriggerProduct:
      description: ReminderTriggerProduct REST model.
      type: object
      properties:
        isActive:
          description: Flag indicating whether this reminder setting is active.
          type: boolean
        product:
          $ref: '#/components/schemas/OpenApiReminderSettingController.Product'
          description: 'Object representing the related Product. When the 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.'
        productId:
          description: Unique identifier representing the related product entity.
          type: string
        referenceNumber:
          description: 'A unique reference number automatically generated by the system.

            The value is unique within the group scope.

            Reference numbers from deleted entities may be reassigned to newly created entities.'
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string