Skip to content
Docs

API Reference

Guardians

Invite and manage guardians; read weekly reports. Guide: Guardians.

get/guardianspost/guardianspost/guardians/{id}/resenddelete/guardians/{id}get/guardians/reports
get/guardians

List guardian links

Scope guardians:read

Parameters

  • student_idquery · string
  • verifiedquery · string
  • pagequery · integer
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/guardians" \
  -H "Authorization: Bearer $GROUT_API_KEY"
post/guardians

Invite a guardian for a student

Scope guardians:write

Body

  • student_idstring
  • guardian_emailstring
  • guardian_typefather|mother|guardian
  • guardian_namestring
  • guardian_phonestring
  • is_primaryboolean
cURL
curl -X POST "https://serverless.grout.app/v1/guardians" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"student_id":"<student_id>","guardian_email":"<guardian_email>","guardian_type":"father","guardian_name":"<guardian_name>","guardian_phone":"<guardian_phone>","is_primary":true}'
post/guardians/{id}/resend

Resend the invitation

Scope guardians:write

Parameters

  • idpath · stringrequired
cURL
curl -X POST "https://serverless.grout.app/v1/guardians/$ID/resend" \
  -H "Authorization: Bearer $GROUT_API_KEY"
delete/guardians/{id}

Remove a guardian link

Scope guardians:write

Parameters

  • idpath · stringrequired
cURL
curl -X DELETE "https://serverless.grout.app/v1/guardians/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/guardians/reports

Weekly guardian reports (Alpha)

Scope guardians:read

Parameters

  • student_idquery · string
  • sincequery · string
  • pagequery · integer
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/guardians/reports" \
  -H "Authorization: Bearer $GROUT_API_KEY"