List immunization compliance for families | SchoolSet

curl https://app.schoolset.io/app/api/v1/immunization/compliance \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Families with immunization compliance gaps for the 2023-2024 academic year.",
  "data": [
    {
      "id": 1024,
      "lastname": "Johnson",
      "parents": [
        {
          "firstName": "Emily",
          "lastName": "Johnson",
          "contactNumber": "+1-555-123-4567",
          "email": "emily.johnson@example.com"
        },
        {
          "firstName": "Michael",
          "lastName": "Johnson",
          "contactNumber": "+1-555-987-6543",
          "email": "michael.johnson@example.com"
        }
      ],
      "immunization": [
        {
          "vaccine": "MMR",
          "dueDate": "2024-05-15",
          "status": "overdue",
          "notes": "Second dose required"
        },
        {
          "vaccine": "DTaP",
          "dueDate": "2024-06-01",
          "status": "pending",
          "notes": "Booster dose upcoming"
        }
      ]
    }
  ]
}

Returns families that currently have immunization compliance gaps in the active academic year.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

Successful GET response for /api/v1/immunization/compliance.

statusenum

Allowed values:

messagestring

datalist of objects