---
title: "Dispatch Board"
method: GET
path: "/api/field/dispatch"
tags: ["field"]
---

# Dispatch Board

`GET /api/field/dispatch`

## Request

- Base URL: `https://api.electricair.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.electricair.io/api/field/dispatch`
- Auth: none declared

## Query parameters

- `start` string, date, required
- `end` string, date, required
- `category` string, nullable

## Response `200`

OK

- DispatchBoardSchema
  - `start` string, date, required
  - `end` string, date, required
  - `timezone` string, required
  - `technicians` DispatchTechnicianSchema[], required
    - `id` integer, required
    - `name` string, required
    - `color` string, required
    - `role` string, required
    - `team` string, required
    - `clocked_in` boolean, required
    - `current_kind` string, nullable
    - `latitude` number, nullable
    - `longitude` number, nullable
    - `location_at` string, date-time, nullable
    - `vehicle_name` string, nullable
  - `visits` DispatchVisitSchema[], required
    - `visit` VisitSchema, required
      - `id` integer, required
      - `job_id` integer, required
      - `starts_at` string, date-time, required
      - `ends_at` string, date-time, required
      - `arrival_window_start` string, date-time, nullable
      - `arrival_window_end` string, date-time, nullable
      - `status` string, required
      - `status_label` string, required
      - `tentative` boolean
      - `notes` string, required
      - `arrived_at` string, date-time, nullable
      - `finished_at` string, date-time, nullable
      - `crew` CrewMemberSchema[], required
        - `id` integer, required
        - `name` string, required
        - `color` string, required
        - `role` string, required
        - `team` string, required
        - `is_lead` boolean, required
        - `vehicle_name` string, nullable
    - `job` JobCardSchema, required: A job as it appears on a list or the schedule board.
      - `id` integer, required
      - `number` string, required
      - `summary` string, required
      - `job_type_id` integer, required
      - `job_type_name` string, required
      - `category` string, required
      - `business_unit` string, required
      - `status` string, required
      - `status_label` string, required
      - `priority` integer, required
      - `customer_name` string, required
      - `address` AddressSchema
        - `line1` string, required
        - `line2` string, required
        - `city` string, required
        - `state` string, required
        - `postal_code` string, required
        - `formatted` string, required
        - `latitude` number, nullable
        - `longitude` number, nullable
      - `project_id` integer, nullable
      - `deal_id` integer, nullable
      - `service_request_id` integer, nullable
      - `customer_id` integer, nullable
      - `estimated_hours` number, nullable
      - `planned_days` integer
      - `sold_hours` number, nullable
      - `crew_size` integer
      - `suggest_helper` boolean
      - `plan_note` string
      - `next_visit_at` string, date-time, nullable
      - `completed_at` string, date-time, nullable
      - `forms_open` integer
      - `job_summary` string
      - `starts_at` string, date-time, nullable
      - `finish_at` string, date-time, nullable
      - `finish_overridden` boolean
      - `unbooked_days` string[]
      - `appointments_needed` integer
      - `appointments_booked` integer
      - `appointments_crewed` integer
      - `appointments_started` integer
      - `tags` DispatchTagSchema[]
        - `key` string, required
        - `label` string, required
        - `detail` string, required
  - `unscheduled` JobCardSchema[], required
    - `id` integer, required
    - `number` string, required
    - `summary` string, required
    - `job_type_id` integer, required
    - `job_type_name` string, required
    - `category` string, required
    - `business_unit` string, required
    - `status` string, required
    - `status_label` string, required
    - `priority` integer, required
    - `customer_name` string, required
    - `address` AddressSchema
      - `line1` string, required
      - `line2` string, required
      - `city` string, required
      - `state` string, required
      - `postal_code` string, required
      - `formatted` string, required
      - `latitude` number, nullable
      - `longitude` number, nullable
    - `project_id` integer, nullable
    - `deal_id` integer, nullable
    - `service_request_id` integer, nullable
    - `customer_id` integer, nullable
    - `estimated_hours` number, nullable
    - `planned_days` integer
    - `sold_hours` number, nullable
    - `crew_size` integer
    - `suggest_helper` boolean
    - `plan_note` string
    - `next_visit_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `forms_open` integer
    - `job_summary` string
    - `starts_at` string, date-time, nullable
    - `finish_at` string, date-time, nullable
    - `finish_overridden` boolean
    - `unbooked_days` string[]
    - `appointments_needed` integer
    - `appointments_booked` integer
    - `appointments_crewed` integer
    - `appointments_started` integer
    - `tags` DispatchTagSchema[]
      - `key` string, required
      - `label` string, required
      - `detail` string, required
  - `blocks` BlockSchema[], required
    - `id` integer, required
    - `technician_id` integer, required
    - `technician_name` string, required
    - `kind` string, required
    - `kind_label` string, required
    - `starts_at` string, date-time, required
    - `ends_at` string, date-time, required
    - `notes` string, required
  - `capacity` CapacityDaySchema[], required
    - `day` string, date, required
    - `crews` integer, required
    - `confirmed` integer, required
    - `tentative` integer, required
    - `open` integer, required
    - `crews_off` integer, required

## Changes

> 22 revisions in range; 1 not diffed.

- **2026-10-28** `558d42db3b2e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/changes/api/field/dispatch/get.md)

---

[API](https://skmtc.dev/electricair/apis/electric-air-autoquote-api.md) - [All operations](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/llms.txt) - [OpenAPI document](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/revisions/a13d832a5676?raw)