- 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:
studentIdis specified, and the requesting user is not permitted to view guardian information for that student, if
"-"is specified as the
studentIdand the user is not a domain administrator, if guardians are not enabled for the domain in question, if the
invitedEmailAddressfilter is set by a user who is not a domain administrator, or for other access errors.
studentIdis specified, but its format cannot be recognized (it is not an email address, nor a
studentIdfrom the API, nor the literal string
me). May also be returned if an invalid
studentIdis specified, and its format can be recognized, but Classroom has no record of that student.
The URL uses gRPC Transcoding syntax.
Filter results by the student who the guardian is linked to. The identifier can be one of the following:
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.
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.
The request body must be empty.
Response when listing guardians.
If successful, the response body contains data with the following structure:
Guardians on this page of results that met the criteria specified in the request.
Token identifying the next page of results to return. If empty, no further results are available.
Requires one of the following OAuth scopes:
For more information, see the Authorization guide.