Digitail Pets Archive API

The Pets Archive API from Digitail — 3 operation(s) for pets archive.

Operations 4

GET /api/v1/pet-archive-types List all ArchiveTypes #
GET /api/v1/pets/{id}/archive Check Pet Archive #
POST /api/v1/pets/{id}/archive Archive Pet #
POST /api/v1/pets/{id}/un-archive UnArchive Pet #

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-pets-archive-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

digitail-pets-archive-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Digitail Pets Archive 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: Pets Archive
paths:
  /api/v1/pet-archive-types:
    get:
      tags:
      - Pets Archive
      summary: List all ArchiveTypes
      description: 'Permissions needed: NONE

        Get the list of Pets Archive Types'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      title: PetArchiveType
                      description: The reason why a pet was archived
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: Deceased
                        translation_slug:
                          type: string
                          example: strings.deceased
                        translation_label:
                          type: string
                          example: Deceased
        '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: getApiV1PetArchiveTypes
      x-operation-id-source: derived
  /api/v1/pets/{id}/archive:
    get:
      tags:
      - Pets Archive
      summary: Check Pet Archive
      description: 'Permissions needed: ACCESS_PATIENTS

        Returns the list of Archive info for Pet'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      - $ref: '#/paths/~1api~1v1~1pets/get/parameters/0'
      - $ref: '#/paths/~1api~1v1~1pets/get/parameters/1'
      - name: filter[archive_type_id]
        in: query
        description: 'Archive type ID '
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          description: '`1` - Deceased `2` - Moved away `3` - Change of owner `4` - Other

            '
      - $ref: '#/paths/~1api~1v1~1tags/get/parameters/5'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      title: PetArchive
                      description: The record of a pet being archived. Larger version of the simple Archive
                      properties:
                        id:
                          type: integer
                          example: 1
                        pet_id:
                          type: integer
                          example: 1
                        vet_id:
                          type: integer
                          example: 1
                        clinic_id:
                          type: integer
                          example: 1
                        archive_type_id:
                          type: integer
                          enum:
                          - 1
                          - 2
                          - 3
                          - 4
                          description: '`1` - Deceased `2` - Moved away `3` - Change of owner `4` - Other

                            '
                          example: 1
                        reason:
                          type: string
                          example: The patient was archived because...
                        created_at:
                          type: string
                          example: '2023-06-21T10:30:07.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'
        '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: getApiV1PetsByIdArchive
      x-operation-id-source: derived
    post:
      tags:
      - Pets Archive
      summary: Archive Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        Archive a Pet'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                clinic_id:
                  description: Clinic ID
                  type: integer
                  example: 766
                vet_id:
                  description: Vet ID
                  type:
                  - integer
                  - 'null'
                  example: null
                archive_type_id:
                  type: integer
                  enum:
                  - 1
                  - 2
                  - 3
                  - 4
                  description: '`1` - Deceased `2` - Moved away `3` - Change of owner `4` - Other

                    '
                reason:
                  description: Reason/Comment
                  type: string
                  example: We archived Daisy because she moved away.
              type: object
      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: postApiV1PetsByIdArchive
      x-operation-id-source: derived
  /api/v1/pets/{id}/un-archive:
    post:
      tags:
      - Pets Archive
      summary: UnArchive Pet
      description: 'Permissions needed: ACCESS_PATIENTS

        UnArchive a Pet'
      parameters:
      - $ref: '#/paths/~1api~1v1~1sales/delete/parameters/0'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                clinic_id:
                  description: Clinic ID
                  type: integer
                  example: 766
      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: postApiV1PetsByIdUnArchive
      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)