Quick Start

Get access in the portal

Sign in to portal.grout.app as an Institution Admin and open Developers in the sidebar. Either create an API key directly on the API keys tab, or invite a developer who will get their own dashboard. No portal account yet? Start with Institution Account.

Create a key

Give it a name and pick scopes. For this walkthrough choose students:read and institution:read. The full key (grt_live_…) is shown once — copy it into a secret manager.

Call /v1/me

curl https://serverless.grout.app/v1/me \
  -H "Authorization: Bearer $GROUT_API_KEY"

You should see your institution, the key's scopes and its rate limit:

{
  "success": true,
  "data": {
    "key_id": "key_…", "name": "Quick start", "environment": "live",
    "institution": { "id": "…", "name": "Example College" },
    "scopes": ["students:read", "institution:read"],
    "rate_limit_per_min": 600, "request_id": "req_…"
  }
}

List your students

curl "https://serverless.grout.app/v1/students?limit=5" \
  -H "Authorization: Bearer $GROUT_API_KEY"

Pick a path