Skip to content
Docs

API Reference

Faculty

Provision and manage faculty accounts. Guide: Faculty.

get/facultypost/facultyget/faculty/{id}patch/faculty/{id}get/faculty/{id}/exams
get/faculty

List faculty

Scope faculty:read

Parameters

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

Provision a faculty member

Scope faculty:write

Body

  • full_namestring
  • faculty_idstring
  • license_daysinteger
cURL
curl -X POST "https://serverless.grout.app/v1/faculty" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"full_name":"<full_name>","faculty_id":"<faculty_id>","license_days":0}'
get/faculty/{id}

Get a faculty member

Scope faculty:read

Parameters

  • idpath · stringrequired
cURL
curl -X GET "https://serverless.grout.app/v1/faculty/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
patch/faculty/{id}

Update a faculty member

Scope faculty:write

Parameters

  • idpath · stringrequired

Body

  • full_namestring
  • faculty_idstring|null
  • statusactive|suspended
cURL
curl -X PATCH "https://serverless.grout.app/v1/faculty/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"full_name":"<full_name>","faculty_id":"string","status":"active"}'
get/faculty/{id}/exams

Exams owned by a faculty member

Scope exams:read

Parameters

  • idpath · stringrequired
  • pagequery · integer
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/faculty/$ID/exams" \
  -H "Authorization: Bearer $GROUT_API_KEY"