Digitail

Digitail Prescriptions API

The Prescriptions API from Digitail — 1 operation(s) for prescriptions.

GitHub OpenAPI

Operations 9

GET /api/v1/pets/{id}/prescriptions List all Prescriptions for Pet #
POST /api/v1/pets/{id}/prescriptions Create Prescription for Pet #
GET /api/v1/pets/{id}/prescriptions/{prescription} Retrieve Prescription for Pet #
PATCH /api/v1/pets/{id}/prescriptions/{prescription} Update Prescription for Pet #
DELETE /api/v1/pets/{id}/prescriptions/{prescription} Delete Prescription for Pet #
GET /api/v1/prescriptions/{id}/refills List all Refills for Prescription #
POST /api/v1/prescriptions/{id}/refills Create Refill for Prescription #
GET /api/v1/prescriptions/{id}/refills/{refill} Retrieve Refill for Prescription #
PATCH /api/v1/prescriptions/{id}/refills/{refill} Update Refill for Prescription #

Documentation

📖
Documentation
https://documentation.digitail.io/
📖
APIReference
https://documentation.digitail.io/list-all-pets
📖
APIReference
https://documentation.digitail.io/get-all-appointments
📖
APIReference
https://documentation.digitail.io/retrieve-a-vet
📖
APIReference
https://documentation.digitail.io/retrieve-a-clinic

Specifications

⚙
OpenAPI
https://artifacts.apis.io/digitail/openapi/digitail-prescriptions-api-openapi.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/digitail:digitail-prescriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

digitail-prescriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Digitail Prescriptions 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: Prescriptions
paths:
  /api/v1/pets/{id}/prescriptions:
    get:
      tags:
      - Prescriptions
      summary: List all Prescriptions for Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        Get pet''s prescriptions'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - $ref: '#/paths/~1api~1v1~1pets/get/parameters/0'
      - name: filter[status]
        in: query
        description: Prescription's Status
        required: true
        schema:
          type: string
      - $ref: '#/paths/~1api~1v1~1tags/get/parameters/5'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/paths/~1api~1v1~1pets~1%7Bid%7D~1prescriptions/post/responses/201/content/application~1json/schema/properties/data'
                  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'
        '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: getApiV1PetsByIdPrescriptions
      x-operation-id-source: derived
    post:
      tags:
      - Prescriptions
      summary: Create Prescription for Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        Store Prescriptions for a specific patient'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - clinic_id
              - vet_id
              - quantity
              - prescribed_at
              - status
              - max_refills
              properties:
                record_id:
                  type:
                  - integer
                  - 'null'
                  example: 1
                clinic_id:
                  type: integer
                  example: 1
                vet_id:
                  type: integer
                  example: 1
                product_id:
                  type: integer
                  example: 1
                product_name:
                  description: (<font color='red'>required</font> when <i>product_id</i> is  <i>null</i>)
                  type: string
                type:
                  type: integer
                  enum:
                  - 0
                  - 1
                  description: '`0` - External `1` - In House

                    '
                  example: 0
                quantity:
                  type: integer
                  example: 5
                unit_id:
                  type: integer
                  example: 1
                unit:
                  description: (<font color='red'>required</font> when <i>unit_id</i> is  <i>null</i>)
                  type: string
                  example: Tablet
                label:
                  description: Label
                  type:
                  - string
                  - 'null'
                  example: 1/2 Tablet every day
                prescribed_at:
                  type: string
                  format: date
                  example: '2020-01-01'
                expiration_date:
                  type: string
                  format: date
                  example: '2020-01-01'
                status:
                  type: string
                  enum:
                  - ACTIVE
                  - INACTIVE
                  example: ACTIVE
                internal_notes:
                  type:
                  - string
                  - 'null'
                  example: Internal notes
      responses:
        '201':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    title: Prescription
                    description: Prescriptions can be dispensed to patients for medications.
                    properties:
                      id:
                        type: integer
                        example: 1
                      record_id:
                        type: integer
                        example: 1
                      clinic_id:
                        type: integer
                        example: 1
                      vet_id:
                        type: integer
                        example: 1
                      pet_id:
                        type: integer
                        example: 1
                      product_id:
                        type: integer
                        example: 1
                      product_name:
                        type:
                        - string
                        - 'null'
                        example: Product name
                      type:
                        type: integer
                        enum:
                        - 0
                        - 1
                        description: '`0` - External `1` - In House

                          '
                        example: 0
                      quantity:
                        type: integer
                        example: 1
                      unit_id:
                        type:
                        - integer
                        - 'null'
                        example: 1
                      unit:
                        type:
                        - string
                        - 'null'
                        example: Unit
                      label:
                        type:
                        - string
                        - 'null'
                        example: Administer 1 tablet by mouth every 12 hours for 7 days
                      prescribed_at:
                        type: string
                        format: date-time
                        example: '2020-01-01T00:00:00Z'
                      expires_at:
                        type: string
                        format: date-time
                        example: '2020-01-01T00:00:00Z'
                      status:
                        type: string
                        enum:
                        - ACTIVE
                        - INACTIVE
                        example: ACTIVE
                      delivery_status:
                        type: string
                        example: Complete
                      delivery_provider:
                        type: string
                        example: vetsource
                      internal_notes:
                        type:
                        - string
                        - 'null'
                        example: Internal notes
                      product_ext_id:
                        type: string
                      prescription_ext_id:
                        type: string
                      order_ext_id:
                        type: string
                      refills_received:
                        type: integer
                        example: 1
                      max_refills:
                        type: integer
                        example: 3
                      last_refill_at:
                        type: string
                        format: date-time
                        example: '2020-01-01T00:00:00Z'
                      refills:
                        type: array
                        items:
                          $ref: '#/paths/~1api~1v1~1prescriptions~1%7Bid%7D~1refills/post/responses/201/content/application~1json/schema/properties/data'
                      created_at:
                        type: string
                        format: date-time
                        example: '2022-02-06T22:00:00.000000Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2022-02-06T22:00:00.000000Z'
        '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'
        '422':
          $ref: '#/paths/~1api~1v1~1plans/get/responses/422'
        '429':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/429'
      operationId: postApiV1PetsByIdPrescriptions
      x-operation-id-source: derived
  /api/v1/pets/{id}/prescriptions/{prescription}:
    get:
      tags:
      - Prescriptions
      summary: Retrieve Prescription for Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        Get pet''s prescription by id'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - name: prescription
        in: path
        description: Prescription Id
        required: true
        schema:
          type: integer
      - name: include
        in: query
        description: 'Additional info to include. Ex.: ''clinic'',''record'',''product'',''vet'',''pet'',''pet.owners'',''pet.breed'',''pet.species'',''refills'',''refills.refillProducts'''
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/paths/~1api~1v1~1pets~1%7Bid%7D~1prescriptions/post/responses/201/content/application~1json/schema/properties/data'
        '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: getApiV1PetsByIdPrescriptionsByPrescription
      x-operation-id-source: derived
    patch:
      tags:
      - Prescriptions
      summary: Update Prescription for Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        Update Prescriptions for Pet'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - name: prescription
        in: path
        description: Prescription Id
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                vet_id:
                  type: integer
                  example: 1
                product_id:
                  type: integer
                  example: 1
                product_name:
                  description: (<font color='red'>required</font> when <i>product_id</i> is  <i>null</i>)
                  type: string
                type:
                  type: integer
                  enum:
                  - 0
                  - 1
                  description: '`0` - External `1` - In House

                    '
                  example: 0
                quantity:
                  type: integer
                  example: 5
                unit_id:
                  type: integer
                  example: 1
                unit:
                  description: (<font color='red'>required</font> when <i>unit_id</i> is  <i>null</i>)
                  type: string
                  example: Tablet
                label:
                  description: Label
                  type:
                  - string
                  - 'null'
                  example: 1/2 Tablet every day
                prescribed_at:
                  type: string
                  format: date
                  example: '2020-01-01'
                expiration_date:
                  type: string
                  format: date
                  example: '2020-01-01'
                status:
                  type: string
                  enum:
                  - ACTIVE
                  - INACTIVE
                  example: ACTIVE
                internal_notes:
                  type:
                  - string
                  - 'null'
                  example: Internal notes
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/paths/~1api~1v1~1pets~1%7Bid%7D~1prescriptions/post/responses/201/content/application~1json/schema/properties/data'
        '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'
        '422':
          $ref: '#/paths/~1api~1v1~1plans/get/responses/422'
        '429':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/429'
      operationId: patchApiV1PetsByIdPrescriptionsByPrescription
      x-operation-id-source: derived
    delete:
      tags:
      - Prescriptions
      summary: Delete Prescription for Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        Delete a pet Prescriptions'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - name: prescription
        in: path
        description: Prescription Id
        required: true
        schema:
          type: integer
      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'
        '429':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/429'
      operationId: deleteApiV1PetsByIdPrescriptionsByPrescription
      x-operation-id-source: derived
  /api/v1/prescriptions/{id}/refills:
    get:
      tags:
      - Prescriptions
      summary: List all Refills for Prescription
      description: 'Permissions needed: ACCESS_PATIENTS

        Get prescription''s refills'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - name: include
        in: query
        description: 'Additional info to include. Ex.: refillProducts'
        required: false
        schema:
          type: string
      - $ref: '#/paths/~1api~1v1~1tags/get/parameters/5'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/paths/~1api~1v1~1prescriptions~1%7Bid%7D~1refills/post/responses/201/content/application~1json/schema/properties/data'
                  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'
        '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: getApiV1PrescriptionsByIdRefills
      x-operation-id-source: derived
    post:
      tags:
      - Prescriptions
      summary: Create Refill for Prescription
      description: 'Permissions needed: ACCESS_PATIENTS

        Create a new refill for a said prescription'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - record_id
              - vet_id
              - refilled_at
              properties:
                record_id:
                  type: integer
                  example: 1
                vet_id:
                  type: integer
                  example: 1
                type:
                  type: integer
                  enum:
                  - 0
                  - 1
                  description: '`0` - External `1` - In House

                    '
                  example: 0
                label:
                  type:
                  - string
                  - 'null'
                  example: 1/2 Tablet every day
                refilled_at:
                  type: string
                  format: date
                  example: '2020-01-01'
                internal_notes:
                  type:
                  - string
                  - 'null'
                  example: Internal notes
                quantity:
                  description: 'Overrides the dispensed quantity for this refill. Defaults to the prescription quantity when omitted. Ignored for external and treatment-based refills.

                    '
                  type:
                  - number
                  - 'null'
                  example: 10
                  exclusiveMinimum: 0
                max_refills:
                  description: 'Overrides the prescription''s maximum number of refills and is persisted on the prescription. Lowering it below the number of existing refills rejects the request.

                    '
                  type:
                  - integer
                  - 'null'
                  minimum: 0
                  example: 3
      responses:
        '201':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    title: Refill
                    description: An individual refill of a prescription.
                    properties:
                      id:
                        type: integer
                        example: 1
                      prescription_id:
                        type: integer
                        example: 1
                      record_id:
                        type:
                        - integer
                        - 'null'
                        example: 1
                      vet_id:
                        type: integer
                        example: 1
                      type:
                        type: integer
                        enum:
                        - 0
                        - 1
                        description: '`0` - External `1` - In House

                          '
                        example: 0
                      label:
                        type:
                        - string
                        - 'null'
                        example: Refill
                      refilled_at:
                        type: string
                        format: date-time
                        example: '2020-01-01T00:00:00.000Z'
                      is_initial:
                        type: boolean
                        example: false
                      number:
                        type: integer
                        example: 1
                      internal_notes:
                        type:
                        - string
                        - 'null'
                        example: Internal Notes
        '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'
        '422':
          $ref: '#/paths/~1api~1v1~1plans/get/responses/422'
        '429':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/429'
      operationId: postApiV1PrescriptionsByIdRefills
      x-operation-id-source: derived
  /api/v1/prescriptions/{id}/refills/{refill}:
    get:
      tags:
      - Prescriptions
      summary: Retrieve Refill for Prescription
      description: 'Permissions needed: ACCESS_PATIENTS

        Get prescription''s refill by id'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - name: refill
        in: path
        description: Prescription Refill Id
        required: true
        schema:
          type: integer
      - name: include
        in: query
        description: 'Additional info to include. Ex.: refillProducts'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/paths/~1api~1v1~1prescriptions~1%7Bid%7D~1refills/post/responses/201/content/application~1json/schema/properties/data'
        '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: getApiV1PrescriptionsByIdRefillsByRefill
      x-operation-id-source: derived
    patch:
      tags:
      - Prescriptions
      summary: Update Refill for Prescription
      description: 'Permissions needed: ACCESS_PATIENTS

        Update a specific refill for a prescription'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - name: refill
        in: path
        description: Refill Id
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - vet_id
              properties:
                vet_id:
                  type: integer
                  example: 1
                type:
                  type: integer
                  enum:
                  - 0
                  - 1
                  description: '`0` - External `1` - In House

                    '
                  example: 0
                refilled_at:
                  type: string
                  format: date
                  example: '2020-01-01'
                label:
                  type:
                  - string
                  - 'null'
                  example: 1/2 Tablet every day
                internal_notes:
                  type:
                  - string
                  - 'null'
                  example: Internal notes
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/paths/~1api~1v1~1prescriptions~1%7Bid%7D~1refills/post/responses/201/content/application~1json/schema/properties/data'
        '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'
        '422':
          $ref: '#/paths/~1api~1v1~1plans/get/responses/422'
        '429':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/429'
      operationId: patchApiV1PrescriptionsByIdRefillsByRefill
      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)