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 OAuth 2.0 Overview.

Try it!