Skip to content

API Reference

Institution

Institution profile, counts and the integration config consumed by the desktop apps. Guide: Institution Account.

get/institution

Institution profile, user and license counts

Scope institution:read

cURL
curl -X GET "https://serverless.grout.app/v1/institution" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/institution/config

Read integration config

Scope institution:read

cURL
curl -X GET "https://serverless.grout.app/v1/institution/config" \
  -H "Authorization: Bearer $GROUT_API_KEY"
put/institution/config

Replace integration config (default AI policy, proctoring, toolchains, LMS)

Scope institution:write

Body

  • default_ai_policyobject
  • default_proctoringobject
  • allowed_toolchainsstring[]
  • toolchain_mirrorobject|null
  • lmsobject
cURL
curl -X PUT "https://serverless.grout.app/v1/institution/config" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"default_ai_policy":{},"default_proctoring":{},"allowed_toolchains":[],"toolchain_mirror":{},"lms":{}}'