Are your users using Classroom with Google Meet? Check out the Apps Script quickstart covering how to check student attendance in Google Meet courses.

Method: invitations.list

Stay organized with collections Save and categorize content based on your preferences.

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.

Note: At least one of userId or courseId must be supplied. Both fields can be supplied.

This method returns the following error codes:

HTTP request


The URL uses gRPC Transcoding syntax.

Query parameters



Restricts returned invitations to those for a specific user. 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


Restricts returned invitations to those for a course with the specified identifier.



Maximum number of items to return. The default is 500 if unspecified or 0.

The server may return fewer than the specified number of results.



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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response when listing invitations.

JSON representation
  "invitations": [
      object (Invitation)
  "nextPageToken": string

object (Invitation)

Invitations that match the list request.



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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the OAuth 2.0 Overview.