Digitail Visit Types API

The Visit Types API from Digitail — 1 operation(s) for visit types.

Operations 3

GET /api/v1/visit-types/group-by-category List all Visit Types Grouped by Category #
GET /api/v1/visit-types/categories List all Visit Type Categories #
GET /api/v1/visit-types List all Visit Types #

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-visit-types-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.

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

OpenAPI Specification

digitail-visit-types-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Digitail Visit Types 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: Visit Types
paths:
  /api/v1/visit-types/group-by-category:
    get:
      tags:
      - Visit Types
      summary: List all Visit Types Grouped by Category
      description: 'Permissions needed: ACCESS_ADMINISTRATION_SETTINGS'
      parameters:
      - $ref: '#/paths/~1api~1v1~1files/get/parameters/6'
      - name: filter[clinic_group_id]
        in: query
        required: false
        schema:
          type: integer
      - name: filter[is_enterprise_mode]
        in: query
        required: false
        description: 'When `true` and `filter[clinic_id]` is set, returns clinic-level visit types together with group-level visit types of the clinic''s group that have not yet been copied to the clinic (i.e., have no active `template_id` reference). Soft-deleted clinic copies do not block the corresponding group template from appearing.

          '
        schema:
          type: boolean
      - $ref: '#/paths/~1api~1v1~1vets/get/parameters/2'
      - $ref: '#/paths/~1api~1v1~1tags/get/parameters/4'
      - name: filter[available_for_variant_content]
        in: query
        required: false
        schema:
          type: integer
      - name: filter[with_trashed_that_have_service_packages]
        in: query
        required: false
        schema:
          type: boolean
      - name: include
        in: query
        required: false
        schema:
          type: string
        description: 'Include additional data: printableFiles, servicePackages, instances, vets'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        category:
                          type: string
                        label:
                          type: string
                        visit_types:
                          type: array
                          items:
                            $ref: '#/paths/~1api~1v1~1visit-types/get/responses/200/content/application~1json/schema/properties/data/items'
        '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: getApiV1VisitTypesGroupByCategory
      x-operation-id-source: derived
  /api/v1/visit-types/categories:
    get:
      tags:
      - Visit Types
      summary: List all Visit Type Categories
      description: 'Permissions needed: ACCESS_ADMINISTRATION_SETTINGS'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        category:
                          type: string
                          enum:
                          - consultation_exams
                          - vaccines
                          - preventive_vaccines
                          - euthanasia
                          - spay_neuter
                          - medical_procedures
                          - imagining_diagnostics
                          - boarding
                          - grooming
                          - microchipping
                          - other
                          - admin
                        label:
                          type: string
        '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: getApiV1VisitTypesCategories
      x-operation-id-source: derived
  /api/v1/visit-types:
    get:
      tags:
      - Visit Types
      summary: List all Visit Types
      description: 'Permissions needed: ACCESS_ADMINISTRATION_SETTINGS'
      parameters:
      - $ref: '#/paths/~1api~1v1~1files/get/parameters/6'
      - name: filter[clinic_group_id]
        in: query
        required: false
        schema:
          type: integer
      - name: filter[is_enterprise_mode]
        in: query
        required: false
        description: 'When `true` and `filter[clinic_id]` is set, returns clinic-level visit types together with group-level visit types of the clinic''s group that have not yet been copied to the clinic (i.e., have no active `template_id` reference). Soft-deleted clinic copies do not block the corresponding group template from appearing.

          '
        schema:
          type: boolean
      - $ref: '#/paths/~1api~1v1~1vets/get/parameters/2'
      - $ref: '#/paths/~1api~1v1~1tags/get/parameters/4'
      - name: filter[available_for_variant_content]
        in: query
        required: false
        schema:
          type: integer
      - name: filter[with_trashed_that_have_service_packages]
        in: query
        required: false
        schema:
          type: boolean
      - name: include
        in: query
        required: false
        schema:
          type: string
        description: 'Include additional data: printableFiles, servicePackages, instances, taskTemplates, vets'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      title: Visit Type
                      properties:
                        id:
                          type: integer
                        clinic_id:
                          type:
                          - integer
                          - 'null'
                        clinic_group_id:
                          type:
                          - integer
                          - 'null'
                        template_id:
                          type:
                          - integer
                          - 'null'
                        name:
                          type: string
                        description:
                          type: string
                        category:
                          type: string
                          enum:
                          - consultation_exams
                          - vaccines
                          - preventive_vaccines
                          - euthanasia
                          - spay_neuter
                          - medical_procedures
                          - imagining_diagnostics
                          - boarding
                          - grooming
                          - microchipping
                          - other
                          - admin
                        duration:
                          type: integer
                        is_visible:
                          type: boolean
                        is_notifiable:
                          type: boolean
                        color:
                          type: string
                        order:
                          type:
                          - integer
                          - 'null'
                        deposit_for_online_booking:
                          type: number
                          format: float
                        is_drop_off_enabled:
                          type: boolean
                        default_drop_off_time:
                          type:
                          - string
                          - 'null'
                          example: 09:00
                        default_drop_off_vet_id:
                          type:
                          - integer
                          - 'null'
                        default_drop_off_vet:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: integer
                            first_name:
                              type: string
                            last_name:
                              type: string
                            avatar:
                              type: string
                            job_title:
                              type: string
                        created_at:
                          type:
                          - string
                          - 'null'
                          example: '2024-11-27T10:06:56.000000Z'
                        printable_files:
                          type:
                          - array
                          - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                        service_packages:
                          type:
                          - array
                          - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              description:
                                type: string
                              unit_price:
                                type:
                                - string
                                - 'null'
                              price:
                                type:
                                - string
                                - 'null'
                              price_include_tax:
                                type:
                                - boolean
                                - 'null'
                              tax:
                                type:
                                - number
                                - 'null'
                                format: float
                        vets:
                          type:
                          - array
                          - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              first_name:
                                type: string
                              last_name:
                                type: string
                              avatar:
                                type: string
                              job_title:
                                type: string
                        instances:
                          type:
                          - array
                          - 'null'
                          items:
                            $ref: '#/paths/~1api~1v1~1visit-types/get/responses/200/content/application~1json/schema/properties/data/items'
                        task_templates:
                          type:
                          - array
                          - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                  links:
                    $ref: '#/paths/~1api~1v1~1plans/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: getApiV1VisitTypes
      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)