Get School Settings Structure Tree

GET

https://app.schoolset.io/app/api/v2/school/settings/structure/tree/:year_id

GET

/app/api/v2/school/settings/structure/tree/:year_id

1 curl https://app.schoolset.io/app/api/v2/school/settings/structure/tree/year_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "School structure tree retrieved successfully.",
4   "data": [
5     {
6       "academic_year": {
7         "id": 2023,
8         "title": "Academic Year 2023-2024",
9         "slug": "academic-year-2023-2024",
10         "start_at": "2023-09-01T00:00:00Z",
11         "end_at": "2024-06-30T23:59:59Z",
12         "active": 1,
13         "is_visible": 1,
14         "created_by": "admin_user",
15         "created_at": "2023-05-15T10:00:00Z",
16         "updated_at": "2023-08-01T12:00:00Z"
17       },
18       "tree": {
19         "id": 10,
20         "name": "Main Campus",
21         "type": "campus",
22         "children": [
23           {
24             "id": 101,
25             "name": "Grade 1",
26             "type": "grade",
27             "children": [
28               {
29                 "id": 1011,
30                 "name": "Class 1A",
31                 "type": "class",
32                 "children": []
33               },
34               {
35                 "id": 1012,
36                 "name": "Class 1B",
37                 "type": "class",
38                 "children": []
39               }
40             ],
41             "permission_to_delete": false,
42             "created_at": "2023-06-01T09:00:00Z",
43             "updated_at": "2023-07-01T09:00:00Z"
44           },
45           {
46             "id": 102,
47             "name": "Grade 2",
48             "type": "grade",
49             "children": [],
50             "permission_to_delete": false,
51             "created_at": "2023-06-01T09:00:00Z",
52             "updated_at": "2023-07-01T09:00:00Z"
53           }
54         ],
55         "permission_to_delete": true,
56         "created_at": "2023-05-20T08:00:00Z",
57         "updated_at": "2023-08-01T12:00:00Z"
58       }
59     }
60   ]
61 }

Returns school structure tree 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

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects