Get immunizations by family | SchoolSet

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

{
  "status": "success",
  "message": "Immunization records retrieved successfully.",
  "data": [
    {
      "id": 12345,
      "student": {
        "firstname": "Ethan",
        "firstname_hebrew": "איתן",
        "lastname": "Goldberg",
        "lastname_hebrew": "גולדברג",
        "full_name": "Ethan Goldberg",
        "dob": "2010-04-15",
        "dob_hebrew": "תשע\"א ניסן ט\"ו",
        "grade": {
          "year": 5,
          "name": "5th Grade"
        },
        "no_results": false
      },
      "parents": [
        {
          "firstname": "Rachel",
          "lastname": "Goldberg",
          "phone": "+1-555-123-4567",
          "email": "rachel.goldberg@example.com"
        }
      ],
      "immunizations": {
        "MMR": {
          "date_administered": "2016-05-20",
          "status": "complete",
          "notes": "Administered at local clinic"
        },
        "DTaP": {
          "date_administered": "2015-11-10",
          "status": "complete",
          "notes": "No adverse reactions"
        },
        "Varicella": {
          "date_administered": "2016-06-15",
          "status": "complete",
          "notes": "Second dose"
        }
      }
    }
  ]
}

Returns immunization summaries and records for all students in the selected family, optionally filtered by academic year.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/immunization/family/{id}.

statusenum

Allowed values:

messagestring

datalist of objects