Get immunization communication history | SchoolSet

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

{
  "status": "success",
  "message": "Immunization communication history retrieved successfully.",
  "data": [
    {
      "type": "email",
      "value": {
        "subject": "Reminder: Upcoming Immunization Appointment",
        "recipient": "parent.johnson@example.com",
        "status": "sent"
      },
      "date": "2024-05-10T09:15:00Z"
    },
    {
      "type": "sms",
      "value": {
        "phoneNumber": "+15551234567",
        "message": "Your child has an immunization appointment scheduled for 2024-05-15.",
        "status": "delivered"
      },
      "date": "2024-05-09T14:30:00Z"
    },
    {
      "type": "voice",
      "value": {
        "phoneNumber": "+15557654321",
        "callDurationSeconds": 45,
        "status": "completed"
      },
      "date": "2024-05-08T16:00:00Z"
    },
    {
      "type": "note",
      "value": {
        "author": "Nurse Kelly",
        "content": "Parent confirmed appointment via phone call."
      },
      "date": "2024-05-08T16:05:00Z"
    }
  ]
}

Returns note, SMS, voice, and email activity timeline entries for the selected student immunization.

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/history/{id}.

statusenum

Allowed values:

messagestring

datalist of objects