Skip to content
Docs

Grout Institution API

Build with Grout

The institution API behind GroutApp, GroutCode and the Guardians portal. Provision students and faculty, launch them into the desktop apps from your LMS, create and grade exams, credit AI merits, and receive signed webhooks. One institution-scoped key, plain HTTPS + JSON.

Quick StartOpen the portal
72
Endpoints
22
Event types
<5 min
SSO launch
First request
curl https://serverless.grout.app/v1/me \
  -H "Authorization: Bearer grt_live_…"

# → { "success": true,
#     "data": { "institution": { … },
#               "scopes": ["students:write", …] } }

Quick Start

Get an API key and make your first call in five minutes.

Institution Account

Register on the portal, get approved, invite developers.

People & Access

Provision students and faculty, groups, licenses, SSO into the apps.

Exams

Create, assign and grade exams, including GroutCode coding exams.

Webhooks

Signed events with retries so your LMS stays in sync.

API Reference

Every endpoint, scope and body field, with cURL samples.

How it fits together#

Grout is three apps and one portal. GroutApp is the offline-first AI learning studio, GroutCode is the coding studio with proctored coding exams, and the Guardians portal at audit.grout.app lets parents follow progress. Institutions administer all of it from portal.grout.app.

The Institution API sits underneath the portal. Everything an admin can do by hand, your integration can do with an API key: create people, hand out licenses, sign students into the apps, run exams, credit AI merits, and get told when something happens.

Institution Account

Register, get approved, and find the Developers tab in the portal.

API Keys & Scopes

Least-privilege keys, rotation, rate limits.

SSO Launch

One-click "Open in GroutCode" from your LMS.

Webhooks

Signed, retried events for grades, licenses and more.

Who this is for#

  • LMS and SIS teams syncing rosters and grades with Moodle, Canvas or an in-house system.
  • Institution developers invited by an admin from the portal.
  • AI agents — every page is available as markdown; start at /developer/llms.txt and read AGENTS.md.

Conventions used in these docs#

$API means https://serverless.grout.app/v1 and $KEY is an institution API key. Request bodies are JSON unless a page says multipart. Timestamps are ISO-8601 UTC. Path parameters written {id} accept the internal id or, for people, the generated login email.

NextWhy Grout?