---
title: Retrieve Reminder Protocol Usages HTML Preview
slug: retrieve-reminder-protocol-usages-html-preview
docTags: 
createdAt: 2026-04-21T15:22:49.957Z
---

{
  "id": "PzFcBHx7wMOIcz2hUiMco",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://developer.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview",
    "servers": [
      {
        "url": "https://developer.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview",
        "description": "Sandbox server (uses test data)"
      },
      {
        "url": "https://vet.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview",
        "description": "Production server (uses live data)"
      }
    ],
    "name": "Retrieve Reminder Protocol Usages HTML Preview",
    "description": "<p>Permissions needed: ACCESS_PATIENTS\nPreview Reminder Protocol Usages pdf</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/pdf"
          ],
          "default": "application/pdf"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "filter[reminder_protocol_template_ids]",
          "type": "string",
          "description": "Filters by an array of Protocol Templates IDs"
        },
        {
          "kind": "optional",
          "name": "filter[date_after]",
          "type": "string",
          "description": "<p>Filter the usages that have administration_date bigger or equal than the given date (Y-m-d)</p>"
        },
        {
          "kind": "optional",
          "name": "filter[date_before]",
          "type": "string",
          "description": "<p>Filter the usages that have administration_date smaller or equal than the given date (Y-m-d)</p>"
        },
        {
          "kind": "optional",
          "name": "filter[exclude_historical]",
          "type": "boolean",
          "description": "Exclude usages generated by custom products added from the pet's health card"
        },
        {
          "kind": "optional",
          "name": "filter[clinic_id]",
          "type": "integer",
          "description": "Filter by clinic ID"
        },
        {
          "kind": "optional",
          "name": "filter[vet_id]",
          "type": "integer",
          "description": "Filter by vet ID"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "passport",
          "name": "passport",
          "kind": "optional",
          "type": "oauth2",
          "description": "Laravel passport oauth2 security.",
          "oauth2Flows": {
            "authorizationCode": {
              "authorizationUrl": "https://digitail.test/oauth/authorize",
              "tokenUrl": "https://digitail.test/oauth/token",
              "refreshUrl": "https://digitail.test/oauth/token"
            }
          }
        },
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "successful operation",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "dhZYFWD8olH9OaffqoSj7",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://developer.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview \\\n     --header 'accept: application/pdf'"
        },
        {
          "id": "g6GFbzhzCnPFAwevohQYi",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/pdf\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "fYbSxTUnQ1-AorvCylRM9",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/pdf\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "1GMa2duaDQmqg1FRhofPK",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/pets/{pet}/reminder-protocols/preview\"\n\npayload = {}\nheaders = {\n   'accept': 'application/pdf',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "dhZYFWD8olH9OaffqoSj7"
    },
    "results": {
      "languages": [
        {
          "id": "_Agfe0WfGfnj3Hr_LIIpS",
          "language": "200",
          "code": "// successful operation\n"
        }
      ],
      "selectedLanguageId": "_Agfe0WfGfnj3Hr_LIIpS"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}