Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: userProfiles.guardianInvitations.get
Stay organized with collections
Save and categorize content based on your preferences.
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 gRPC Transcoding 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 Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: userProfiles.guardianInvitations.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n- `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](/workspace/classroom/reference/Access.Errors).\n- `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`).\n- `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.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|------------------------------------------------------------------------------|\n| `studentId` | `string` The ID of the student whose guardian invitation is being requested. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` being requested. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
