Get information about all students of this user. | SchoolSet

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

{
  "status": "success",
  "message": "Student records retrieved successfully.",
  "data": {
    "id": 101,
    "name": "Greenwood High School",
    "schoolGrades": [
      {
        "id": 5,
        "name": "Grade 10",
        "root_school_grade_id": null,
        "schoolClasses": [
          {
            "id": 12,
            "batch_id": 2024,
            "name": "10-A",
            "level": 10,
            "active": true,
            "root_school_class_id": null,
            "school_grade_id": 5,
            "migrates_from_id": null,
            "migration_from_model": null,
            "created_by_user_id": 3,
            "deleted_at": null,
            "created_at": "2023-08-15T09:00:00Z",
            "updated_at": "2024-04-10T12:00:00Z"
          }
        ],
        "batch_id": 2024,
        "created_by": "admin_user",
        "students": [
          {
            "id": 501,
            "firstname": "Emma",
            "lastname": "Johnson",
            "full_name": "Emma Johnson",
            "children": [],
            "type": "student",
            "photo_url": "https://app.schoolset.io/photos/emma_johnson.jpg",
            "family_student_id": null,
            "addresses": [
              {
                "id": 301,
                "components": [
                  "123 Maple Street",
                  "Springfield",
                  "IL",
                  "62704"
                ],
                "splitted": [
                  "123 Maple Street",
                  "Springfield",
                  "IL",
                  "62704"
                ],
                "formatted": "123 Maple Street, Springfield, IL 62704",
                "longitude": -89.65,
                "latitude": 39.7817,
                "tag": "home"
              }
            ],
            "created_by": "admin_user",
            "created_at": "2023-09-01T08:30:00Z",
            "updated_at": "2024-04-01T10:15:00Z"
          }
        ],
        "children": [],
        "type": "grade",
        "created_at": "2023-07-01T07:00:00Z",
        "updated_at": "2024-03-20T11:00:00Z"
      }
    ],
    "schoolDepartments": [
      {
        "id": 2,
        "name": "Science Department",
        "root_school_department_id": null,
        "schoolGrades": [],
        "schoolClasses": [],
        "batch_id": 2024,
        "created_by": "dept_head",
        "children": [],
        "type": "department",
        "created_at": "2022-01-10T09:00:00Z",
        "updated_at": "2024-02-15T14:00:00Z"
      }
    ],
    "children": [],
    "type": "school",
    "permission_to_delete": false,
    "created_at": "2020-05-20T08:00:00Z",
    "updated_at": "2024-04-10T12:00:00Z"
  }
}

Lists student records for the active school context.

Authentication

AuthorizationBearer

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

Response

JSON response payload for the student tree.

statusenum

Allowed values:

messagestring

dataobject