Method: userProfiles.guardianInvitations.get

Returns a specific guardian invitation.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view guardian invitations 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 Classroom cannot find any record of the given student or invitationId. May also be returned if the student exists, but the requesting user does not have access to see that student.

HTTP request

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
studentId

string

The ID of the student whose guardian invitation is being requested.

invitationId

string

The id field of the GuardianInvitation being requested.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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.