Get Registration | SchoolSet

curl https://app.schoolset.io/app/api/v2/registration/list/year_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Registration records retrieved successfully for the academic year 2023-2024.",
  "data": [
    {
      "id": 1024,
      "batch_id": {
        "id": "B2023-01",
        "name": "Batch 2023 - Grade 1"
      },
      "name": "The Johnson Family",
      "parents": [
        {
          "parent_id": 501,
          "name": "Emily Johnson",
          "relation": "Mother",
          "contact_number": "+1-555-123-4567",
          "email": "emily.johnson@example.com"
        },
        {
          "parent_id": 502,
          "name": "Michael Johnson",
          "relation": "Father",
          "contact_number": "+1-555-987-6543",
          "email": "michael.johnson@example.com"
        }
      ],
      "status": "Active",
      "status_id": 1,
      "by_passed": false,
      "system": [
        {
          "created_by": "admin_user",
          "created_at": "2023-08-15T09:30:00Z",
          "last_updated": "2023-09-01T14:45:00Z"
        }
      ],
      "file": [
        {
          "file_id": 301,
          "file_name": "birth_certificate.pdf",
          "uploaded_at": "2023-08-16T10:00:00Z"
        }
      ],
      "document_template": [
        {
          "template_id": 201,
          "template_name": "Enrollment Form",
          "version": "v2.1"
        }
      ],
      "form": [
        {
          "form_id": 401,
          "form_name": "Medical Information",
          "submitted": true
        }
      ],
      "checkbox": [
        {
          "checkbox_id": 601,
          "label": "Consent to field trips",
          "checked": true
        }
      ],
      "students_data": [
        {
          "student_id": 1001,
          "name": "Samantha Johnson",
          "has_admission_card": true,
          "status": "Enrolled"
        },
        {
          "student_id": 1002,
          "name": "Ethan Johnson",
          "has_admission_card": false,
          "status": "Pending"
        }
      ]
    }
  ]
}

Returns or updates registration records for families in the selected academic year.

Authentication

AuthorizationBearer

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

Path parameters

year_idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects