List

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided

5 variables
7 variables

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.

This method returns the following error codes:

  • PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token or state is provided.
  • NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage guardians for students in your Google Classroom classes
  • View guardians for students in your Google Classroom classes

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

studentId STRING Required

The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user
  • the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.

pageToken STRING

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token

invitedEmailAddress STRING

If specified, only results with the specified invited_email_address will be returned

states ENUMERATION

If specified, only results with the specified state values will be returned. Otherwise, results with a state of PENDING will be returned

pageSize INTEGER

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

Output

This building block provides 7 output parameters

  = Parameter name
  = Format

nextPageToken STRING

Token identifying the next page of results to return. If empty, no further results are available

guardianInvitations[] OBJECT

An invitation to become the guardian of a specified user, sent to a specified email address

guardianInvitations[].creationTime ANY

The time that this invitation was created.

Read-only

guardianInvitations[].invitationId STRING

Unique identifier for this invitation.

Read-only

guardianInvitations[].studentId STRING

ID of the student (in standard format)

guardianInvitations[].state ENUMERATION

The state that this invitation is in

guardianInvitations[].invitedEmailAddress STRING

Email address that the invitation was sent to. This field is only visible to domain administrators