Get School Settings Tree | SchoolSet

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

{
  "status": "success",
  "message": "Settings tree retrieved successfully.",
  "data": {
    "id": 101,
    "name": "Main School Settings",
    "type": "root",
    "children": [
      {
        "id": 102,
        "name": "Academic Calendar",
        "type": "category",
        "children": [
          {
            "id": 103,
            "name": "Semester Dates",
            "type": "setting",
            "value": "2024-01-10 to 2024-06-15"
          },
          {
            "id": 104,
            "name": "Holidays",
            "type": "setting",
            "value": [
              "2024-04-01",
              "2024-05-01"
            ]
          }
        ],
        "permission_to_delete": 0,
        "created_at": "2023-11-01T09:00:00Z",
        "updated_at": "2024-04-10T12:00:00Z"
      }
    ],
    "permission_to_delete": true,
    "created_at": "2023-10-15T08:30:00Z",
    "updated_at": "2024-04-10T12:00:00Z"
  }
}

Lists settings 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

dataobject