Understaffing Warnings

Identify days within a date range where booking demand exceeds available staffed hours.

Endpoint

GET /v1/staff/schedule/understaffing

Authentication

Requires an API key with the staff:read scope.

Query Parameters

Parameter	Type	Required	Description
start_date	string	Yes	Start of date range (YYYY-MM-DD)
end_date	string	Yes	End of date range (YYYY-MM-DD, must be ≥ start_date)

Response

Success (200 OK)

{
  "data": [
    {
      "date": "2026-04-10",
      "booking_count": 18,
      "shift_count": 2,
      "staffed_hours": 16,
      "warning": "High demand with limited staff coverage"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-04-01T09:00:00+00:00"
  }
}

An empty data array means no understaffing warnings were found for the period.

Errors

Status	Code	Description
401	authentication_required	No API key provided
401	invalid_api_key	Invalid API key
403	insufficient_scope	API key lacks staff:read scope
422	validation_error	Missing or invalid date fields

Example Request

curl -X GET "https://app.equipdash.com/api/v1/staff/schedule/understaffing?start_date=2026-04-07&end_date=2026-04-13" \
  -H "Authorization: Bearer eqd_live_abc123xyz789..."