---
title: Get a list of reminder protocol usage for a pet
slug: get-a-list-of-reminder-protocol-usage-for-a-pet
docTags:
createdAt: 2026-04-21T15:22:49.957Z
---
{
"id": "nHUuxsVpGzJjekcv43Aj8",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://developer.digitail.io/api/v1/reminder-protocol-usages",
"servers": [
{
"url": "https://developer.digitail.io/api/v1/reminder-protocol-usages",
"description": "Sandbox server (uses test data)"
},
{
"url": "https://vet.digitail.io/api/v1/reminder-protocol-usages",
"description": "Production server (uses live data)"
}
],
"name": "Get a list of reminder protocol usage for a pet",
"description": "Returns list of all of the reminder protocol usage for a pet. This information can be found in the UI on the pet's profile page under the \"Preventive\" tab.\n",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [
{
"kind": "optional",
"name": "filter[reminder_protocol_template_id]",
"type": "integer",
"description": "Filter by reminder protocol template ID including the ones with the same treatment_type. The treatment_type is only applicable for clinic groups.
"
},
{
"kind": "optional",
"name": "filter[reminder_protocol_template_ids]",
"type": "string",
"description": "Filters by an array of Protocol Templates IDs"
},
{
"kind": "optional",
"name": "filter[latest]",
"type": "boolean",
"description": "Filter by latest usage for each reminder protocol template"
},
{
"kind": "optional",
"name": "filter[due_date_type]",
"type": "string",
"description": "Filter by the state of an usage",
"enum": [
"due",
"overdue",
"upcoming"
]
},
{
"kind": "optional",
"name": "filter[active]",
"type": "boolean",
"description": "Filter by active status"
},
{
"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[date_before]",
"type": "string",
"description": "Filter the usages that have administration_date smaller or equal than the given date (Y-m-d)
"
},
{
"kind": "optional",
"name": "filter[date_after]",
"description": "Filter the usages that have administration_date bigger or equal than the given date (Y-m-d)
"
},
{
"kind": "optional",
"name": "filter[last_fetched]",
"type": "string",
"description": "Filter the usages that have been updated after the given date (Y-m-d)
"
}
],
"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,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "reminder_protocol_template_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "record_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "pet_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "vet_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "treatment_type_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "due_date",
"kind": "optional",
"type": "string",
"description": "This date is in the clinic's timezone, this will be deprecated in the future so please use the due_date_utc field
",
"example": "2022-09-28T00:00:00.000Z",
"format": "date"
},
{
"name": "administration_date",
"kind": "optional",
"type": "string",
"description": "This date is in the clinic's timezone, this will be deprecated in the future so please use the administration_date_utc field
",
"example": "2022-09-28T00:00:00.000Z",
"format": "date"
},
{
"name": "clinic",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1clinic~1%7Bid%7D/get/responses/200/content/application~1json/schema/properties/data",
"customType": "data",
"schema": []
},
{
"name": "due_date_utc",
"kind": "optional",
"type": "string",
"description": "",
"example": "2022-09-28T00:00:00.000Z",
"format": "date"
},
{
"name": "administration_date_utc",
"kind": "optional",
"type": "string",
"description": "",
"example": "2022-09-28T00:00:00.000Z",
"format": "date"
},
{
"name": "overwritten_by",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "is_active",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
},
{
"name": "pet",
"kind": "optional",
"type": "object",
"description": "General information about the pet.",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "nickname",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "species",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "label",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "breed",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "label",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "species_id",
"kind": "optional",
"type": "integer",
"description": ""
}
]
},
{
"name": "birthday",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "gender",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"male",
"female",
"unknown"
]
},
{
"name": "hormonal_status",
"kind": "optional",
"type": "integer",
"description": "",
"enum": [
"0",
"1",
"2"
]
},
{
"name": "profile_picture",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "protocol_template",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Reminder Protocol Template"
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "is_enabled",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "product_categories",
"kind": "optional",
"type": "array",
"description": "",
"example": "[{\"id\":74,\"product_category_id\":153,\"name\":\"Stupefiante\",\"products\":[{\"id\":36,\"name\":\"Product\"}],\"created_at\":\"2023-07-11T15:24:15.000000Z\"}]",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 74
},
{
"name": "product_category_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 153
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Stupefiante"
},
{
"name": "products",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 36
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Vaccine"
}
]
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-07-11T15:24:15.000Z",
"format": "date-time"
}
]
},
{
"name": "visit_types",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "visit_type_id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "services",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-07-11T07:41:16.000Z",
"format": "date-time"
}
]
},
{
"name": "template_overwrites",
"kind": "optional",
"type": "array",
"description": "",
"example": "[{\"id\":2,\"name\":\"Reminder Protocol Template Overwritten by this Protocol\"}]",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "template_overwritten_by",
"kind": "optional",
"type": "array",
"description": "",
"example": "[{\"id\":3,\"name\":\"Reminder Protocol Template that Overwrites this Protocol\"}]",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "intervals",
"kind": "optional",
"type": "array",
"description": "",
"example": "[{\"id\":1,\"duration\":1,\"unit\":\"day\",\"time_to_in_days\":1}]",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "duration",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "unit",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "time_to_in_days",
"kind": "optional",
"type": "integer",
"description": ""
}
]
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-06-27T15:12:43.000000Z",
"format": "date-time"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-06-27T15:12:43.000000Z",
"format": "date-time"
}
]
},
{
"name": "protocol_usage_items",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "reminder_protocol_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "reminder_protocol_usage_itemable_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "reminder_protocol_usage_itemable_type",
"kind": "optional",
"type": "string",
"description": "",
"example": "App\\\\Models\\\\Treatment"
},
{
"name": "reminder_protocol_usage_itemable",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Product #9911"
},
{
"name": "batch_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "Test batch - 1123"
},
{
"name": "manufacturer",
"kind": "optional",
"type": "string",
"description": "",
"example": "Test manufacturer"
},
{
"name": "rabic_tag_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "Rabic - #12121"
},
{
"name": "expiration_date",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-11-22T00:00:00.000Z",
"format": "date"
},
{
"name": "printed_files",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Test certificate"
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": "",
"example": "Test title"
},
{
"name": "real_name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Test real name.pdf"
},
{
"name": "printable_file_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "vet_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 6
},
{
"name": "patient_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 2
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-09-14T11:26:45.000000Z",
"format": "date-time"
}
]
}
]
}
]
}
]
},
{
"name": "links",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/links",
"customType": "links",
"schema": []
},
{
"name": "meta",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta",
"customType": "meta",
"schema": []
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "22S6Jz-rJuwPgVAsVAHhM",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/reminder-protocol-usages \\\n --header 'accept: application/json'"
},
{
"id": "G7TDFFJCUvBdBvEITfEpL",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\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/reminder-protocol-usages\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "bN7UlwoAH3Dt7cS-sAqt5",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/reminder-protocol-usages\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "k4FboIUUcM31g7u2NE-Z7",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/reminder-protocol-usages\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "22S6Jz-rJuwPgVAsVAHhM"
},
"results": {
"languages": [
{
"id": "GZgyaxgeuhCDx09XrTIzs",
"language": "200",
"code": "// Successful operation\n{\n \"data\": [\n {\n \"id\": 1,\n \"clinic_id\": 1,\n \"reminder_protocol_template_id\": 1,\n \"record_id\": 1,\n \"pet_id\": 1,\n \"vet_id\": 1,\n \"treatment_type_id\": 1,\n \"due_date\": \"2022-09-28T00:00:00.000Z\",\n \"administration_date\": \"2022-09-28T00:00:00.000Z\",\n \"clinic\": {},\n \"due_date_utc\": \"2022-09-28T00:00:00.000Z\",\n \"administration_date_utc\": \"2022-09-28T00:00:00.000Z\",\n \"overwritten_by\": 1,\n \"is_active\": true,\n \"pet\": {\n \"id\": 0,\n \"nickname\": \"\",\n \"species\": {\n \"id\": 0,\n \"label\": \"\"\n },\n \"breed\": {\n \"id\": 0,\n \"label\": \"\",\n \"species_id\": 0\n },\n \"birthday\": \"\",\n \"gender\": \"\",\n \"hormonal_status\": 0,\n \"profile_picture\": \"\"\n },\n \"protocol_template\": {\n \"id\": 1,\n \"name\": \"Reminder Protocol Template\",\n \"clinic_id\": 1,\n \"is_enabled\": 1,\n \"product_categories\": [\n {\n \"id\": 74,\n \"product_category_id\": 153,\n \"name\": \"Stupefiante\",\n \"products\": [\n {\n \"id\": 36,\n \"name\": \"Vaccine\"\n }\n ],\n \"created_at\": \"2023-07-11T15:24:15.000Z\"\n }\n ],\n \"visit_types\": [\n {\n \"id\": 0,\n \"visit_type_id\": 0,\n \"name\": \"\",\n \"services\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ],\n \"created_at\": \"2023-07-11T07:41:16.000Z\"\n }\n ],\n \"template_overwrites\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ],\n \"template_overwritten_by\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ],\n \"intervals\": [\n {\n \"id\": 0,\n \"duration\": 0,\n \"unit\": \"\",\n \"time_to_in_days\": 0\n }\n ],\n \"created_at\": \"2023-06-27T15:12:43.000000Z\",\n \"updated_at\": \"2023-06-27T15:12:43.000000Z\"\n },\n \"protocol_usage_items\": [\n {\n \"id\": 1,\n \"reminder_protocol_id\": 1,\n \"reminder_protocol_usage_itemable_id\": 1,\n \"reminder_protocol_usage_itemable_type\": \"App\\\\\\\\Models\\\\\\\\Treatment\",\n \"reminder_protocol_usage_itemable\": {\n \"name\": \"Product #9911\",\n \"batch_number\": \"Test batch - 1123\",\n \"manufacturer\": \"Test manufacturer\",\n \"rabic_tag_number\": \"Rabic - #12121\",\n \"expiration_date\": \"2023-11-22T00:00:00.000Z\",\n \"printed_files\": [\n {\n \"id\": 1,\n \"name\": \"Test certificate\",\n \"title\": \"Test title\",\n \"real_name\": \"Test real name.pdf\",\n \"printable_file_id\": 1,\n \"vet_id\": 6,\n \"patient_id\": 2,\n \"created_at\": \"2023-09-14T11:26:45.000000Z\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"links\": {},\n \"meta\": {}\n}"
}
],
"selectedLanguageId": "GZgyaxgeuhCDx09XrTIzs"
}
},
"children": [
{
"text": ""
}
]
}