---
title: "Get appointments report"
method: GET
path: "/api/v1/reports/appointments"
tags: ["Reports"]
---

# Get appointments report

`GET /api/v1/reports/appointments`

Get appointments report

## Query parameters

- `filter[vet_id]` string
- `filter[source]` string
- `filter[status]` 'created_by_vet' | 'requested_by_user' | 'rescheduled_by_vet' | 'requested_reschedule_by_user' | 'confirmed' | 'canceled_by_user' | 'canceled_by_vet' | 'auto_created' | 'no_show' | 'pending' | 'completed'
- `filter[date_between]` string[]
- `filter[visit_type_id]` string
- `filter[has_payment_deposits]` boolean
- `sort` string

## Parameters

- `#/paths/~1api~1v1~1pets/get/parameters/0` — unresolved $ref
- `#/paths/~1api~1v1~1tags/get/parameters/5` — unresolved $ref
- `#/paths/~1api~1v1~1pets/get/parameters/11` — unresolved $ref

## Response `200`

successful operation

- object
  - `data` object[]
    - `id` integer
    - `datetime_start_utc` string, date-time
    - `datetime_end_utc` string, date-time
    - `status` 'created_by_vet' | 'requested_by_user' | 'rescheduled_by_vet' | 'requested_reschedule_by_user' | 'confirmed' | 'canceled_by_user' | 'canceled_by_vet' | 'auto_created' | 'no_show' | 'pending' | 'completed'
    - `source` integer — `0` - Vet `1` - Pet Parent `2` - Mobile
    - `pet` object
      - `id` integer
      - `nickname` string
      - `species` Items — unresolved $ref
      - `breed` Items — unresolved $ref
      - `pet_parents` object[]
        - `id` integer
        - `name` string
        - `last_name` string
        - `phone` string
        - `address` string
        - `address_2` string
        - `email` string
        - `chat_uid` string, nullable
      - `age` string
      - `archive` object, nullable — Archive details for an archived pet, in the shape returned by the report resources (App\Http\Resources\Reports\Shared\PetArchiveResource). Drives the frontend archived badge / legacy name emoji.
        - `type` 'Deceased' | 'Moved away' | 'Change of owner' | 'Other'
        - `archived_at` string, nullable
        - `reason` string, nullable
      - `patient` object, nullable
        - `id` integer
        - `clinic_id` integer
        - `number` string
    - `clinic` object
      - `id` integer
      - `name` string
    - `vet` object
      - `id` integer
      - `first_name` string
      - `last_name` string
      - `job_title` string
    - `payment_deposits` object
      - `id` integer
      - `value` number, float
      - `paid_value` number, float
      - `status` 'paid' | 'pending' | 'partially_paid'
      - `appointments` Items[] — unresolved $ref
      - `payment_links` object[]
        - `id` integer
        - `amount` string, float
        - `url` string
    - `guest` boolean
    - `pet_name` string, nullable
    - `pet_parent_name` string, nullable
    - `pet_parent_email` string, nullable
    - `pet_parent_phone` string, nullable
    - `revenue` string, float
    - `utm_source` string, nullable
    - `services` object[], nullable
      - `id` integer
      - `name` string
    - `last_confirmed_at` string, date-time, nullable
    - `confirmed_by` 'client' | 'staff', nullable
    - `confirmation_source` 'phone' | 'sms_reminder' | 'email_reminder' | 'pet_portal' | 'public_calendar' | 'crm', nullable

## Other responses

- `403` — unresolved $ref
- `422` — unresolved $ref

---

[API](https://skmtc.net/digitail/apis/digitail-api.md) · [All operations](https://skmtc.net/digitail/apis/digitail-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitail/digitail-api/revisions/bd9694db5fce/schema)