Get Dispatch Board | propelone

curl -G https://https//https/dispatch/board \
     -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
     -H "Content-Type: application/json" \
     -d date=2026-03-26 \
     -d tenant_location_id=1 \
     -d team_id=a3f47c9e-8b2d-4f1a-9c3e-2d5b7f6a1e4c \
     -d crew_status=staffed \
     --data-urlencode include=workOrder,technician

{
  "assignments": [
    {
      "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
      "work_order_id": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
      "technician_id": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
      "team_id": "a3f47c9e-8b2d-4f1a-9c3e-2d5b7f6a1e4c",
      "team_dispatch_id": "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
      "crew_status": "staffed",
      "status": "assigned",
      "scheduled_start": "2026-03-26T08:00:00Z",
      "scheduled_end": "2026-03-26T12:00:00Z"
    },
    {
      "id": "e7f8a9b0-c1d2-3e4f-5a6b-7c8d9e0f1a2b",
      "work_order_id": "c5d6e7f8-a9b0-1c2d-3e4f-5a6b7c8d9e0f",
      "technician_id": "12345678-90ab-cdef-1234-567890abcdef",
      "team_id": null,
      "team_dispatch_id": null,
      "crew_status": null,
      "status": "in_progress",
      "scheduled_start": "2026-03-26T09:00:00Z",
      "scheduled_end": "2026-03-26T11:00:00Z"
    }
  ],
  "technicians": [
    {
      "id": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
      "name": "John Doe",
      "status": "available"
    },
    {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "name": "Jane Smith",
      "status": "busy"
    }
  ],
  "work_orders": [
    {
      "id": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
      "description": "HVAC system maintenance",
      "priority": "high",
      "location": "Building A, Floor 3"
    },
    {
      "id": "c5d6e7f8-a9b0-1c2d-3e4f-5a6b7c8d9e0f",
      "description": "Electrical panel inspection",
      "priority": "medium",
      "location": "Building B, Floor 1"
    }
  ]
}

Get the main dispatch board view showing all assignments, technicians, and work orders for a given date. Each assignment object now includes team_id, team_dispatch_id, and crew_status fields (null for non-team-dispatched assignments). Supports filtering by team_id and crew_status.

Query parameters

datestringOptional

Optional: Date to view board for - date format Y-m-d - “2026-03-26”

tenant_location_idstringOptional

Optional: Filter by tenant location - integer - “1”

team_idstringOptional

Optional: Filter to assignments dispatched as part of a specific team - string UUID - “{{team_uuid}}”

crew_statusstringOptional

Optional: Filter by crew status of the parent team-dispatch - staffed|understaffed|lead_missing|none (use “none” for non-team-dispatched only) - “staffed”

includestringOptional

Optional: Relationships to include - comma separated

Response

Successful response

Headers

Query parameters

Response