Get School Structure Grades | SchoolSet

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

{
  "status": "success",
  "message": "School grade structure retrieved successfully.",
  "data": [
    {
      "id": 3,
      "is_active": true,
      "name": "Grade 3",
      "classes": [
        {
          "id": 101,
          "name": "3A",
          "teacher": "Ms. Emily Johnson",
          "room": "B12"
        },
        {
          "id": 102,
          "name": "3B",
          "teacher": "Mr. David Lee",
          "room": "B13"
        }
      ],
      "level": 3,
      "migrates_from": {
        "grade_id": 2,
        "grade_name": "Grade 2"
      },
      "created_by": "admin_user_23",
      "created_at": "2023-08-15T09:30:00Z",
      "updated_at": "2024-04-10T14:45:00Z",
      "students_count": 58,
      "students": [
        {
          "id": 501,
          "name": "Sophia Martinez",
          "age": 8,
          "enrolled_class": "3A"
        },
        {
          "id": 502,
          "name": "Liam Thompson",
          "age": 9,
          "enrolled_class": "3B"
        }
      ]
    }
  ]
}

Returns school grade structure information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

year_idstringRequired

withCountYearIdstringRequired

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects