Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
REST Resource: userProfiles.guardians
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Guardian
Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
JSON representation |
{
"studentId": string,
"guardianId": string,
"guardianProfile": {
object (UserProfile )
},
"invitedEmailAddress": string
} |
Fields |
studentId |
string
Identifier for the student to whom the guardian relationship applies.
|
guardianId |
string
Identifier for the guardian.
|
guardianProfile |
object (UserProfile )
User profile for the guardian.
|
invitedEmailAddress |
string
The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
|
Methods |
|
Deletes a guardian. |
|
Returns a specific guardian. |
|
Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. |
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,["# REST Resource: userProfiles.guardians\n\n- [Resource: Guardian](#Guardian)\n - [JSON representation](#Guardian.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Guardian\n------------------\n\nAssociation between a student and a guardian of that student. The guardian may receive information about the student's course work.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentId\": string, \"guardianId\": string, \"guardianProfile\": { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile) }, \"invitedEmailAddress\": string } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` Identifier for the student to whom the guardian relationship applies. |\n| `guardianId` | `string` Identifier for the guardian. |\n| `guardianProfile` | `object (`[UserProfile](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile)`)` User profile for the guardian. |\n| `invitedEmailAddress` | `string` The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|\n| ### [delete](/workspace/classroom/reference/rest/v1/userProfiles.guardians/delete) | Deletes a guardian. |\n| ### [get](/workspace/classroom/reference/rest/v1/userProfiles.guardians/get) | Returns a specific guardian. |\n| ### [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list) | Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. |"]]