Get School Settings Structure Tree

GET

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

GET

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

1 curl https://app.schoolset.io/app/api/v2/school/settings/structure/tree \
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": "2023-2024 Academic Year",
9         "slug": "2023-2024",
10         "start_at": "2023-09-01T00:00:00Z",
11         "end_at": "2024-06-30T23:59:59Z",
12         "active": true,
13         "is_visible": true,
14         "created_by": "admin_user",
15         "created_at": "2023-05-15T10:20:30Z",
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                 "permission_to_delete": false,
34                 "created_at": "2023-06-01T09:00:00Z",
35                 "updated_at": "2023-08-15T14:30:00Z"
36               },
37               {
38                 "id": 1012,
39                 "name": "Class 1B",
40                 "type": "class",
41                 "children": [],
42                 "permission_to_delete": false,
43                 "created_at": "2023-06-01T09:00:00Z",
44                 "updated_at": "2023-08-15T14:30:00Z"
45               }
46             ],
47             "permission_to_delete": false,
48             "created_at": "2023-05-20T08:00:00Z",
49             "updated_at": "2023-08-10T11:00:00Z"
50           },
51           {
52             "id": 102,
53             "name": "Grade 2",
54             "type": "grade",
55             "children": [],
56             "permission_to_delete": false,
57             "created_at": "2023-05-20T08:00:00Z",
58             "updated_at": "2023-08-10T11:00:00Z"
59           }
60         ],
61         "permission_to_delete": true,
62         "created_at": "2023-05-01T07:30:00Z",
63         "updated_at": "2023-08-01T12:00:00Z"
64       }
65     }
66   ]
67 }

Lists school structure tree records for the active school context.

Authentication

AuthorizationBearer

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

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects