Digitail Reminder Protocol Usages API
The Reminder Protocol Usages API from Digitail — 4 operation(s) for reminder protocol usages.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/digitail:digitail-reminder-protocol-usages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Digitail Reminder Protocol Usages API
description: Digitail API
contact:
email: developer@digitail.io
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
- url: https://developer.digitail.io
description: Sandbox server (uses test data)
- url: https://vet.digitail.io
description: Production server (uses live data)
security:
- passport: []
- Bearer: []
tags:
- name: Reminder Protocol Usages
paths:
/api/v1/reminder-protocol-usages:
get:
tags:
- Reminder Protocol Usages
summary: 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.
parameters:
- $ref: '#/paths/~1api~1v1~1pets/get/parameters/0'
- $ref: '#/paths/~1api~1v1~1files/get/parameters/0'
- name: filter[reminder_protocol_template_id]
in: query
description: 'Filter by reminder protocol template ID including the ones with the same treatment_type. The `treatment_type` is only applicable for clinic groups.
'
schema:
type: integer
- name: filter[reminder_protocol_template_ids]
in: query
description: Filters by an array of Protocol Templates IDs
schema:
type: string
- name: filter[latest]
in: query
description: Filter by latest usage for each reminder protocol template
schema:
type: boolean
- name: filter[due_date_type]
in: query
description: Filter by the state of an usage
schema:
type: string
enum:
- due
- overdue
- upcoming
- name: filter[active]
in: query
description: Filter by active status
schema:
type: boolean
- name: filter[exclude_historical]
in: query
description: Exclude usages generated by custom products added from the pet's health card
schema:
type: boolean
- name: filter[date_before]
in: query
description: Filter the usages that have administration_date smaller or equal than the given date (Y-m-d)
schema:
type: string
- name: filter[date_after]
in: query
description: Filter the usages that have administration_date bigger or equal than the given date (Y-m-d)
- name: filter[last_fetched]
in: query
description: Filter the usages that have been updated after the given date (Y-m-d)
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
title: ReminderProtocolUsage
description: Reminder protocol usage is a record of a treatment that was given to a pet triggered by reminder protocol template.
properties:
id:
type: integer
example: 1
clinic_id:
type: integer
example: 1
reminder_protocol_template_id:
type: integer
example: 1
record_id:
type: integer
example: 1
pet_id:
type: integer
example: 1
vet_id:
type: integer
example: 1
treatment_type_id:
type: integer
example: 1
due_date:
description: This date is in the clinic's timezone, this will be deprecated in the future so please use the due_date_utc field
type: string
format: date
example: '2022-09-28T00:00:00.000Z'
administration_date:
description: This date is in the clinic's timezone, this will be deprecated in the future so please use the administration_date_utc field
type: string
format: date
example: '2022-09-28T00:00:00.000Z'
clinic:
$ref: '#/paths/~1api~1v1~1clinic~1%7Bid%7D/get/responses/200/content/application~1json/schema/properties/data'
due_date_utc:
type: string
format: date
example: '2022-09-28T00:00:00.000Z'
administration_date_utc:
type: string
format: date
example: '2022-09-28T00:00:00.000Z'
overwritten_by:
type: integer
example: 1
is_active:
type: boolean
example: true
pet:
type: object
title: Pet
description: General information about the pet.
properties:
id:
type: integer
nickname:
type: string
species:
type: object
properties:
id:
type: integer
label:
type: string
breed:
type: object
properties:
id:
type: integer
label:
type: string
species_id:
type: integer
birthday:
type: string
gender:
type: string
enum:
- male
- female
- unknown
hormonal_status:
type: integer
enum:
- 0
- 1
- 2
profile_picture:
type: string
protocol_template:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Reminder Protocol Template
clinic_id:
type: integer
example: 1
is_enabled:
type: integer
example: 1
product_categories:
type: array
items:
type: object
properties:
id:
type: integer
example: 74
product_category_id:
type: integer
example: 153
name:
type: string
example: Stupefiante
products:
type: array
items:
type: object
properties:
id:
type: integer
example: 36
name:
type: string
example: Vaccine
created_at:
type: string
format: date-time
example: '2023-07-11T15:24:15.000Z'
example:
- id: 74
product_category_id: 153
name: Stupefiante
products:
- id: 36
name: Product
created_at: '2023-07-11T15:24:15.000000Z'
visit_types:
type: array
items:
type: object
properties:
id:
type: integer
visit_type_id:
type: integer
name:
type: string
services:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
created_at:
type: string
format: date-time
example: '2023-07-11T07:41:16.000Z'
template_overwrites:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
example:
- id: 2
name: Reminder Protocol Template Overwritten by this Protocol
template_overwritten_by:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
example:
- id: 3
name: Reminder Protocol Template that Overwrites this Protocol
intervals:
type: array
items:
type: object
properties:
id:
type: integer
duration:
type: integer
unit:
type: string
time_to_in_days:
type: integer
example:
- id: 1
duration: 1
unit: day
time_to_in_days: 1
created_at:
type: string
format: date-time
example: '2023-06-27T15:12:43.000000Z'
updated_at:
type: string
format: date-time
example: '2023-06-27T15:12:43.000000Z'
protocol_usage_items:
type: array
items:
type: object
title: ReminderProtocolUsageItem
description: Reminder protocol usage item is a type of item that triggered the creation of a reminder protocol usage on a record.
properties:
id:
type: integer
example: 1
reminder_protocol_id:
type: integer
example: 1
reminder_protocol_usage_itemable_id:
type: integer
example: 1
reminder_protocol_usage_itemable_type:
type: string
example: App\\Models\\Treatment
reminder_protocol_usage_itemable:
type: object
properties:
name:
type: string
example: 'Product #9911'
batch_number:
type: string
example: Test batch - 1123
manufacturer:
type: string
example: Test manufacturer
rabic_tag_number:
type: string
example: 'Rabic - #12121'
expiration_date:
type: string
format: date
example: '2023-11-22T00:00:00.000Z'
printed_files:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Test certificate
title:
type: string
example: Test title
real_name:
type: string
example: Test real name.pdf
printable_file_id:
type: integer
example: 1
vet_id:
type: integer
example: 6
patient_id:
type: integer
example: 2
created_at:
type: string
format: date-time
example: '2023-09-14T11:26:45.000000Z'
links:
$ref: '#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/links'
meta:
$ref: '#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta'
'401':
$ref: '#/paths/~1api~1v1~1pets/get/responses/400'
'403':
$ref: '#/paths/~1api~1v1~1pets/get/responses/403'
'429':
$ref: '#/paths/~1api~1v1~1pets/get/responses/429'
operationId: getApiV1ReminderProtocolUsages
x-operation-id-source: derived
/api/v1/pets/{pet}/reminder-protocols/export-pdf:
get:
tags:
- Reminder Protocol Usages
summary: Export reminder protocol usage for a pet
parameters:
- $ref: '#/paths/~1api~1v1~1files/get/parameters/0'
- name: filter[reminder_protocol_template_ids]
in: query
description: Filters by an array of Protocol Templates IDs
required: false
schema:
type: string
- name: filter[date_after]
in: query
description: Filter the usages that have administration_date bigger or equal than the given date (Y-m-d)
required: false
schema:
type: string
- name: filter[date_before]
in: query
description: Filter the usages that have administration_date smaller or equal than the given date (Y-m-d)
required: false
schema:
type: string
- name: filter[exclude_historical]
in: query
description: Exclude usages generated by custom products added from the pet's health card
required: false
schema:
type: boolean
- name: filter[clinic_id]
in: query
description: Filter by clinic ID
required: false
schema:
type: integer
- name: filter[vet_id]
in: query
description: Filter by vet ID
required: false
schema:
type: integer
responses:
'200':
description: successful operation
content:
application/pdf: {}
'400':
$ref: '#/paths/~1api~1v1~1pets/get/responses/400'
'401':
$ref: '#/paths/~1api~1v1~1pets/get/responses/401'
'403':
$ref: '#/paths/~1api~1v1~1pets/get/responses/403'
'429':
$ref: '#/paths/~1api~1v1~1pets/get/responses/429'
operationId: getApiV1PetsByPetReminderProtocolsExportPdf
x-operation-id-source: derived
/api/v1/pets/{pet}/reminder-protocols/preview:
get:
tags:
- Reminder Protocol Usages
summary: Retrieve Reminder Protocol Usages HTML Preview
description: 'Permissions needed: ACCESS_PATIENTS
Preview Reminder Protocol Usages pdf'
parameters:
- $ref: '#/paths/~1api~1v1~1files/get/parameters/0'
- name: filter[reminder_protocol_template_ids]
in: query
description: Filters by an array of Protocol Templates IDs
required: false
schema:
type: string
- name: filter[date_after]
in: query
description: Filter the usages that have administration_date bigger or equal than the given date (Y-m-d)
required: false
schema:
type: string
- name: filter[date_before]
in: query
description: Filter the usages that have administration_date smaller or equal than the given date (Y-m-d)
required: false
schema:
type: string
- name: filter[exclude_historical]
in: query
description: Exclude usages generated by custom products added from the pet's health card
required: false
schema:
type: boolean
- name: filter[clinic_id]
in: query
description: Filter by clinic ID
required: false
schema:
type: integer
- name: filter[vet_id]
in: query
description: Filter by vet ID
required: false
schema:
type: integer
responses:
'200':
description: successful operation
content:
application/pdf: {}
'400':
$ref: '#/paths/~1api~1v1~1pets/get/responses/400'
'401':
$ref: '#/paths/~1api~1v1~1pets/get/responses/401'
'403':
$ref: '#/paths/~1api~1v1~1pets/get/responses/403'
'429':
$ref: '#/paths/~1api~1v1~1pets/get/responses/429'
operationId: getApiV1PetsByPetReminderProtocolsPreview
x-operation-id-source: derived
/api/v1/pets/{pet}/reminder-protocols/sent-email-pdf:
get:
tags:
- Reminder Protocol Usages
summary: Sent Reminder Protocol Usages to email
description: 'Permissions needed: ACCESS_PATIENTS
Sent Reminder Protocol Usages pdf in email'
parameters:
- $ref: '#/paths/~1api~1v1~1files/get/parameters/0'
responses:
'204':
$ref: '#/paths/~1api~1v1~1sales/delete/responses/204'
'400':
$ref: '#/paths/~1api~1v1~1pets/get/responses/400'
'401':
$ref: '#/paths/~1api~1v1~1pets/get/responses/401'
'403':
$ref: '#/paths/~1api~1v1~1pets/get/responses/403'
'429':
$ref: '#/paths/~1api~1v1~1pets/get/responses/429'
operationId: getApiV1PetsByPetReminderProtocolsSentEmailPdf
x-operation-id-source: derived
components:
securitySchemes:
passport:
type: oauth2
description: Laravel passport oauth2 security.
flows:
authorizationCode:
authorizationUrl: https://developer.digitail.io/oauth/authorize
tokenUrl: https://developer.digitail.io/oauth/token
refreshUrl: https://developer.digitail.io/oauth/token
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: harvested
publisher: Digitail
source: https://developer.digitail.io/api-docs
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)