- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.
To list guardians for any student that the requesting user may view guardians for, use the literal character -
for the student ID.
This method returns the following error codes:
PERMISSION_DENIED
if astudentId
is specified, and the requesting user is not permitted to view guardian information for that student, if"-"
is specified as thestudentId
and the user is not a domain administrator, if guardians are not enabled for the domain in question, if theinvitedEmailAddress
filter is set by a user who is not a domain administrator, or for other access errors.INVALID_ARGUMENT
if astudentId
is specified, but its format cannot be recognized (it is not an email address, nor astudentId
from the API, nor the literal stringme
). May also be returned if an invalidpageToken
is provided.NOT_FOUND
if astudentId
is specified, and its format can be recognized, but Classroom has no record of that student.
HTTP request
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
studentId |
Filter results by the student who the guardian is linked to. The identifier can be one of the following:
|
Query parameters
Parameters | |
---|---|
invitedEmailAddress |
Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. |
pageToken |
The |
pageSize |
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
Request body
The request body must be empty.
Response body
Response when listing guardians.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"guardians": [
{
object ( |
Fields | |
---|---|
guardians[] |
Guardians on this page of results that met the criteria specified in the request. |
nextPageToken |
Token identifying the next page of results to return. If empty, no further results are available. |
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 Authorization guide.