Retrieve App Settings

GET

/settings

Requires authenticated session. Requires read:settings permission.

Request

Authorization

API Key

Add parameter in cookie

core.session_token

Example:

core.session_token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Bodyapplication/json

🟠401unauthorized

🟠403forbidden

🔴500server-error

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "CR-100001",
            "field": "string",
            "message": "string"
        }
    ],
    "result": {
        "schoolName": "string",
        "appShortName": "string",
        "logo": "string",
        "loginBackground": "string",
        "enrollmentBanner": "string",
        "enrollmentThankYouImage": "string",
        "activeAcademicYear": "string",
        "attendanceTimezone": "string",
        "address": "string",
        "email": "string",
        "phone": "string",
        "latitude": 0,
        "longitude": 0,
        "schoolDomain": "string",
        "appUrl": "string",
        "emailConfigured": true,
        "emailFrom": "string",
        "forgotPasswordEnabled": true,
        "googleEnabled": true,
        "appleEnabled": true
    }
}

Modified at 2026-07-25 07:30:01

Delete an Existing School Calendar

Update App Settings