Schedule Insights

Returns per-day staffing totals and shift counts for a given week. Use this to get a quick overview of coverage levels.

Endpoint

GET /v1/staff/schedule/insights

Authentication

Requires an API key with the staff:read scope.

Query Parameters

Parameter	Type	Default	Description
week_start	string	Current week Monday	Week to analyse (YYYY-MM-DD, must be a Monday)

Response

Success (200 OK)

{
  "data": {
    "week_start": "2026-03-30",
    "days": [
      {
        "date": "2026-03-30",
        "shift_count": 4,
        "total_hours": 32,
        "staff_ids": [2, 3, 5, 7]
      },
      {
        "date": "2026-03-31",
        "shift_count": 3,
        "total_hours": 24,
        "staff_ids": [2, 5, 7]
      }
    ],
    "totals": {
      "shift_count": 22,
      "total_hours": 176
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-04-01T09:00:00+00:00"
  }
}

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	Invalid week_start format

Example Request

curl -X GET "https://app.equipdash.com/api/v1/staff/schedule/insights?week_start=2026-03-30" \
  -H "Authorization: Bearer eqd_live_abc123xyz789..."