Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/iamalexis689725/cole/llms.txt

Use this file to discover all available pages before exploring further.

Cole is a multi-tenant school management backend built with Laravel 9 and Laravel Sanctum. It provides a complete REST API for running one or many schools from a single deployment, with full isolation between institutions, role-based access for administrators, teachers, students, and parents, and a modular feature system that lets you enable capabilities per school.

Quickstart

Install Cole, seed roles and modules, and make your first authenticated API call in minutes.

Authentication

Learn how Sanctum token auth works, how to obtain a token, and how to pass it in requests.

Core Concepts

Understand multi-tenancy, roles, and the module system before building on top of Cole.

API Reference

Full endpoint documentation with request/response examples for every resource.

What Cole provides

Cole organizes school operations into distinct domains, each with dedicated API endpoints:

Tenant Management

Create and manage school accounts with director users and per-tenant logos.

Academic Periods

Define school years, activate periods, and scope all data to the active term.

Teachers & Subjects

Register teachers, assign subjects, manage teaching loads and schedules.

Students & Enrollment

Enroll students in courses and sections with full profile management.

Grades & Gradebook

Define weighted criteria, record grades, and compute averages automatically.

Attendance

Track daily attendance per class with present, absent, late, and justified states.

Academic Agenda

Post assignments with file attachments and receive student submissions.

Parent Portal

Parents view their children’s grades, attendance, agenda, and anecdotal records.

Circulares

Send school-wide announcements and track who has read them.

How the system is structured

1

Create a tenant (school)

A super-admin creates a tenant record along with its director user. Every piece of data — teachers, students, grades — is scoped to the tenant automatically.
2

Enable modules for the tenant

The super-admin assigns modules (agenda, asistencia, circulares, etc.) to the tenant and activates them. Features behind deactivated modules return 403.
3

Director sets up the school

The director creates academic periods, courses, sections (paralelos), subjects, and registers teachers and students through the director-role endpoints.
4

Teachers and students work

Teachers manage their classes — record attendance, post agenda items, enter grades. Students submit work and view their schedule. Parents follow their children’s progress.
All API endpoints are prefixed with /api. Authentication uses Laravel Sanctum Bearer tokens — see Authentication for details.

Build docs developers (and LLMs) love