---
title: "Get the complete flowboard state for today or a specific date"
method: GET
path: "/Flowboard"
tags: ["Flowboard"]
---

# Get the complete flowboard state for today or a specific date

`GET /Flowboard`

## Query parameters

- `date` string, date-time

## Response `200`

OK

- FlowboardStateDto — Complete flowboard state including all rooms, waiting list, and discharged patients
  - `rooms` FlowboardRoomDto[]
    - `id` string
    - `name` string
    - `status` string
    - `currentVisit` FlowboardVisitDto — A patient visit on the flowboard, derived from appointment and milestone data
      - `id` string
      - `appointmentId` string
      - `patientId` string
      - `patientName` string
      - `species` string, nullable
      - `breed` string, nullable
      - `profilePhotoUrl` string, nullable
      - `clientId` string
      - `clientName` string
      - `clientPhone` string, nullable
      - `reasonForVisit` string
      - `status` string
      - `appointmentTypeId` string, nullable
      - `appointmentTypeName` string, nullable
      - `assignedStaff` FlowboardStaffDto[]
        - `id` string
        - `name` string
        - `avatarUrl` string, nullable
        - `role` string
      - `checkInTime` string, date-time
      - `examStartTime` string, date-time, nullable
      - `treatmentStartTime` string, date-time, nullable
      - `dischargedTime` string, date-time, nullable
      - `currentRoomId` string, nullable
      - `currentRoomName` string, nullable
      - `nextUpRoomId` string, nullable
      - `nextUpQueuedAt` string, date-time, nullable
      - `alerts` FlowboardAlertDto[]
        - `type` string
        - `text` string
        - `level` string
      - `milestones` FlowboardMilestoneDto[]
        - `id` string
        - `name` string
        - `type` integer
        - `status` integer
        - `startedAt` string, date-time, nullable
        - `completedAt` string, date-time, nullable
        - `orderIndex` union
          - integer
          - string, int32
        - `estimatedDurationMinutes` union
          - integer
          - string, int32
        - `actualDurationMinutes` union
          - integer
          - string, int32
      - `progressPercent` union
        - integer
        - string, int32
    - `nextUp` FlowboardVisitDto[]
      - `id` string
      - `appointmentId` string
      - `patientId` string
      - `patientName` string
      - `species` string, nullable
      - `breed` string, nullable
      - `profilePhotoUrl` string, nullable
      - `clientId` string
      - `clientName` string
      - `clientPhone` string, nullable
      - `reasonForVisit` string
      - `status` string
      - `appointmentTypeId` string, nullable
      - `appointmentTypeName` string, nullable
      - `assignedStaff` FlowboardStaffDto[]
        - `id` string
        - `name` string
        - `avatarUrl` string, nullable
        - `role` string
      - `checkInTime` string, date-time
      - `examStartTime` string, date-time, nullable
      - `treatmentStartTime` string, date-time, nullable
      - `dischargedTime` string, date-time, nullable
      - `currentRoomId` string, nullable
      - `currentRoomName` string, nullable
      - `nextUpRoomId` string, nullable
      - `nextUpQueuedAt` string, date-time, nullable
      - `alerts` FlowboardAlertDto[]
        - `type` string
        - `text` string
        - `level` string
      - `milestones` FlowboardMilestoneDto[]
        - `id` string
        - `name` string
        - `type` integer
        - `status` integer
        - `startedAt` string, date-time, nullable
        - `completedAt` string, date-time, nullable
        - `orderIndex` union
          - integer
          - string, int32
        - `estimatedDurationMinutes` union
          - integer
          - string, int32
        - `actualDurationMinutes` union
          - integer
          - string, int32
      - `progressPercent` union
        - integer
        - string, int32
  - `waitingList` FlowboardVisitDto[]
    - `id` string
    - `appointmentId` string
    - `patientId` string
    - `patientName` string
    - `species` string, nullable
    - `breed` string, nullable
    - `profilePhotoUrl` string, nullable
    - `clientId` string
    - `clientName` string
    - `clientPhone` string, nullable
    - `reasonForVisit` string
    - `status` string
    - `appointmentTypeId` string, nullable
    - `appointmentTypeName` string, nullable
    - `assignedStaff` FlowboardStaffDto[]
      - `id` string
      - `name` string
      - `avatarUrl` string, nullable
      - `role` string
    - `checkInTime` string, date-time
    - `examStartTime` string, date-time, nullable
    - `treatmentStartTime` string, date-time, nullable
    - `dischargedTime` string, date-time, nullable
    - `currentRoomId` string, nullable
    - `currentRoomName` string, nullable
    - `nextUpRoomId` string, nullable
    - `nextUpQueuedAt` string, date-time, nullable
    - `alerts` FlowboardAlertDto[]
      - `type` string
      - `text` string
      - `level` string
    - `milestones` FlowboardMilestoneDto[]
      - `id` string
      - `name` string
      - `type` integer
      - `status` integer
      - `startedAt` string, date-time, nullable
      - `completedAt` string, date-time, nullable
      - `orderIndex` union
        - integer
        - string, int32
      - `estimatedDurationMinutes` union
        - integer
        - string, int32
      - `actualDurationMinutes` union
        - integer
        - string, int32
    - `progressPercent` union
      - integer
      - string, int32
  - `dischargedList` FlowboardVisitDto[]
    - `id` string
    - `appointmentId` string
    - `patientId` string
    - `patientName` string
    - `species` string, nullable
    - `breed` string, nullable
    - `profilePhotoUrl` string, nullable
    - `clientId` string
    - `clientName` string
    - `clientPhone` string, nullable
    - `reasonForVisit` string
    - `status` string
    - `appointmentTypeId` string, nullable
    - `appointmentTypeName` string, nullable
    - `assignedStaff` FlowboardStaffDto[]
      - `id` string
      - `name` string
      - `avatarUrl` string, nullable
      - `role` string
    - `checkInTime` string, date-time
    - `examStartTime` string, date-time, nullable
    - `treatmentStartTime` string, date-time, nullable
    - `dischargedTime` string, date-time, nullable
    - `currentRoomId` string, nullable
    - `currentRoomName` string, nullable
    - `nextUpRoomId` string, nullable
    - `nextUpQueuedAt` string, date-time, nullable
    - `alerts` FlowboardAlertDto[]
      - `type` string
      - `text` string
      - `level` string
    - `milestones` FlowboardMilestoneDto[]
      - `id` string
      - `name` string
      - `type` integer
      - `status` integer
      - `startedAt` string, date-time, nullable
      - `completedAt` string, date-time, nullable
      - `orderIndex` union
        - integer
        - string, int32
      - `estimatedDurationMinutes` union
        - integer
        - string, int32
      - `actualDurationMinutes` union
        - integer
        - string, int32
    - `progressPercent` union
      - integer
      - string, int32
  - `timestamp` string, date-time

## Other responses

- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/clinicos/apis/pawthosx-business-api-v1.md) · [All operations](https://skmtc.net/clinicos/apis/pawthosx-business-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clinicos/pawthosx-business-api-v1/versions/a905bde4e796/schema)