# REST Resource: userProfiles.guardianInvitations

- [Resource: GuardianInvitation](https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation)
  - [JSON representation](https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation.SCHEMA_REPRESENTATION)
- [GuardianInvitationState](https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)
- [Methods](https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#METHODS_SUMMARY)

## Resource: GuardianInvitation

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

| JSON representation |
|---|
| ``` { "studentId": string, "invitationId": string, "invitedEmailAddress": string, "state": enum (`https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState`), "creationTime": string } ``` |

| Fields ||
|---|---|
| `studentId` | `string` ID of the student (in standard format) |
| `invitationId` | `string` Unique identifier for this invitation. Read-only. |
| `invitedEmailAddress` | `string` Email address that the invitation was sent to. This field is only visible to domain administrators. |
| `state` | ``enum (`https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState`)`` The state that this invitation is in. |
| `creationTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The time that this invitation was created. Read-only. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## GuardianInvitationState

State of a guardian invitation.

| Enums ||
|---|---|
| `GUARDIAN_INVITATION_STATE_UNSPECIFIED` | Should never be returned. |
| `PENDING` | The invitation is active and awaiting a response. |
| `COMPLETE` | The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/create` | Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. |
| ### `https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/get` | Returns a specific guardian invitation. |
| ### `https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list` | Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. |
| ### `https://developers.google.com/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/patch` | Modifies a guardian invitation. |