Method: userProfiles.guardians.get

Returns a specific guardian.

This method returns the following error codes:

  • PERMISSION_DENIED if no user that matches the provided studentId is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the studentId, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a studentId is specified, but its format cannot be recognized (it is not an email address, nor a studentId from the API, nor the literal string me).
  • NOT_FOUND if the requesting user is permitted to view guardians for the requested studentId, but no Guardian record exists for that student that matches the provided guardianId.

HTTP request

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
studentId

string

The student whose guardian is being requested. One of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user

guardianId

string

The id field from a Guardian.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Guardian.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

For more information, see the OAuth 2.0 Overview.

Try it!

Send feedback about...

Classroom API
Classroom API
Need help? Visit our support page.