Get Family Registration | SchoolSet

curl https://app.schoolset.io/app/api/v1/family/registration/details/school_id/hash \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Registration details retrieved successfully.",
  "data": {
    "id": 12345,
    "academic_year": {
      "id": 2024,
      "title": "2024-2025 Academic Year",
      "start_at": "2024-09-01T00:00:00Z",
      "end_at": "2025-06-30T23:59:59Z",
      "registration_opens": "2024-05-01T08:00:00Z",
      "registration_closes": "2024-08-15T23:59:59Z",
      "early_bird_ends": "2024-06-15T23:59:59Z",
      "early_bird_discount": 10,
      "early_bird_discount_type": "percent"
    },
    "session": {
      "status": "active",
      "step": "3",
      "signer_name": "Rachel Cohen",
      "signed_at": "2024-04-10T14:22:00Z",
      "signature": "SGVsbG8gV29ybGQ="
    },
    "family": {
      "id": 7890,
      "name": "David",
      "lastname_hebrew": "כהן",
      "home_phone": "+1-555-123-4567",
      "address": {
        "street": "123 Maple Street",
        "city": "Springfield",
        "state": "IL",
        "zip": "62704",
        "country": "USA"
      },
      "parents": [
        {
          "id": 1,
          "first_name": "David",
          "last_name": "Cohen",
          "phone": "+1-555-123-4567",
          "email": "david.cohen@example.com"
        },
        {
          "id": 2,
          "first_name": "Sarah",
          "last_name": "Cohen",
          "phone": "+1-555-987-6543",
          "email": "sarah.cohen@example.com"
        }
      ],
      "students": [
        {
          "id": 101,
          "first_name": "Leah",
          "last_name": "Cohen",
          "grade": "5",
          "birthdate": "2013-04-15"
        }
      ],
      "emergency_contacts": [
        {
          "id": 201,
          "name": "Michael Cohen",
          "relationship": "Uncle",
          "phone": "+1-555-222-3333"
        }
      ],
      "doctor": {
        "doctor_name": "Dr. Emily Rosen",
        "doctor_phone": "+1-555-444-5555",
        "doctor_email": "emily.rosen@healthclinic.com",
        "doctor_address": "456 Health Ave, Springfield, IL 62704"
      },
      "authorizations": {
        "allow_tylenol": true,
        "allow_motrin": false,
        "allow_medical_treatment": true
      }
    }
  }
}

Returns registration information for the selected context.

Path parameters

school_idstringRequired

hashstringRequired

Response

Success

statusenum

Allowed values:

messagestring

dataobject