Get

Returns a specific guardian invitation

2 variables
5 variables

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 student_id, 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).
  • NOT_FOUND if Classroom cannot find any record of the given student or invitation_id. May also be returned if the student exists, but the requesting user does not have access to see 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 2 input parameters

  = Parameter name
  = Format

studentId STRING Required

The ID of the student whose guardian invitation is being requested

invitationId STRING Required

The id field of the GuardianInvitation being requested

Output

This building block provides 5 output parameters

  = Parameter name
  = Format

creationTime ANY

The time that this invitation was created.

Read-only

invitationId STRING

Unique identifier for this invitation.

Read-only

studentId STRING

ID of the student (in standard format)

state ENUMERATION

The state that this invitation is in

invitedEmailAddress STRING

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