Gurukul Public API v1

Your school's live data, on any website you like

Every school on Gurukul can expose its notices, events, exam schedules, staff directory, results and admission forms through one read-only REST API. Point your existing website at it, or hand the documentation to a coding agent and let it build the integration for you.

What this is, in one paragraph

Schools already keep their notices, events, exam schedules and staff records in Gurukul. The problem is that the school website is usually a separate thing, updated by hand, and it drifts out of date within a week. The Public API closes that gap: your website reads the same records the office is already maintaining, so publishing a notice in Gurukul publishes it on the website too. There is nothing to sync and nothing to export.

Read-only by default

Ten of the eleven endpoints only read. The single write endpoint accepts admission inquiries and nothing else.

No user accounts

One public token identifies the school. No OAuth, no login, no session to manage. It is safe in browser code.

Private data stays private

Phone numbers, addresses and ID numbers are stripped at the response layer. Draft and unpublished records are never returned.

What you can pull

Eleven endpoints, all under one base URL, all returning JSON.

School profile

Name, address, contact details, affiliation, plus live counts of students, teachers and classes.

Announcements

Published notices, exam alerts and circulars, filtered by type and paginated.

Events

Sports days, cultural programmes, parent meetings and academic dates, filterable by date range.

Holidays

The academic-year holiday list - national, religious and school-specific, with multi-day ranges.

Staff directory

Teachers and staff with designation, department, qualifications and class assignments. All personal data stripped.

Departments

Academic departments with the head of department and a live teacher count.

Exam schedules

Published timetables with per-subject date, time, venue and marks.

Results lookup

Parents check results with a student ID plus date of birth. Two-factor by design, and strictly rate limited.

Gallery

School photos with category filtering and featured images.

Facilities

Classrooms, labs, library and sports facilities, grouped by type.

Admission inquiries

The one write endpoint. Inquiries submitted from your site land in the school's Gurukul dashboard.

Written to be read by machines, too

Most developers integrating this will do it with an AI coding assistant. So the documentation is published in the formats those tools actually consume, rather than leaving them to scrape HTML and guess.

Every page as Markdown

Append .md to any documentation URL and get the raw source. Paste it straight into Claude, ChatGPT or Cursor as context.

See an example

llms.txt and llms-full.txt

The industry-standard index for AI tools. One file listing every page, and another containing the entire reference.

Open llms.txt

A ready-made integration brief

One Markdown file with the task, the rules, a typed client scaffold, every endpoint and a completion checklist. Hand it to a coding agent and it builds the integration.

Download the brief

There is also a prompt menu on every documentation page

Pick one - “Install and configure”, “Integrate this endpoint”, “Build a school website”, “Generate TypeScript types” - and it copies a complete, self-contained prompt to your clipboard. Paste it into Claude Code and you do not have to type anything else. Every request in the docs is also shown in nine languages: cURL, JavaScript, TypeScript, PHP, Python, Go, Java, C# and Ruby.

Getting access

  1. 1

    Ask us for a token

    Every school on Gurukul can have one, on any plan. We generate it and register the domains your website runs on.

  2. 2

    Drop it into your site

    Store it as an environment variable and send it as the X-School-Token header. It is a public identifier, not a secret, so it is safe in client-side code.

  3. 3

    Build, or let an agent build

    Follow the quick start by hand, or download the integration brief and hand it to your coding assistant.