Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: invitations.get
Returns an invitation.
This method returns the following error codes:
PERMISSION_DENIED if the requesting user is not permitted to view the requested invitation or for access errors.NOT_FOUND if no invitation exists with the requested ID.
HTTP request
GET https://classroom.googleapis.com/v1/invitations/{id}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
id |
string
Identifier of the invitation to return.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Invitation.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Returns an invitation based on its ID, providing details like the invitee's role and invitation state."],["Requires authorization with specific scopes for accessing and managing Classroom rosters."],["Potential errors include permission denial if the user lacks access or a \"not found\" error if the invitation ID is invalid."],["Utilizes an HTTP GET request with the invitation ID as a path parameter and an empty request body."],["A successful response provides a comprehensive Invitation object containing relevant information about the invitation."]]],[]]
