Setting Up
Institution Account
Register your institution on the portal, get approved, and find the Developers area.
The Institution API is only available to approved institutions. Everything starts on the portal at portal.grout.app.
- 1
Register the institution
Go to portal.grout.app/institution/register and fill in the institution details, the admin contact and how many student, faculty and lab-machine licenses you need. You will receive an email confirming the request.
- 2
Wait for approval
A Grout admin reviews the request. Once approved you get an email, licenses are generated in the background, and the admin account can sign in. Typical turnaround is one business day. Contact [email protected] to speed things up.
- 3
Sign in as Institution Admin
Open portal.grout.app/login, choose Institution Admin, enter the admin email and the one-time code you receive. There are no passwords.
- 4
Open Developers
In the left sidebar choose Developers. The page has four tabs:
Tab What it does Developers Invite developers by email, resend or revoke invitations, suspend accounts. API keys Create keys with scopes and a rate limit; rename, re-scope, revoke; see usage. Webhooks Register HTTPS endpoints, choose events, send a test ping, rotate secrets. Deliveries Every delivery with status, attempts, response code; open the payload; replay. Direct link: portal.grout.app/institution/developers.
Admin vs developer#
| Institution Admin | Developer | |
|---|---|---|
| Sign in | Institution Admin tile on /login | Developer tile on /login (after accepting an invite) |
| Home | /institution | /developer |
| Invite developers | Yes | No |
| Create / revoke API keys | Yes | Yes |
| Webhooks & deliveries | Yes | Yes |
| See licenses, batches, institution settings | Yes | No |
Developers only see the developer platform; they cannot change licenses or institution settings. Suspending a developer ends their sessions immediately and, by default, revokes every key they created.
What the API can see#
Everything is scoped to the institution the key belongs to. The API reads and writes the same tables the portal uses, so a student created by POST /students appears on the portal's license batches, and a group created in the portal is visible to GET /groups.