List

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

4 variables
6 variables

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 user_id or course_id must be supplied. Both fields can be supplied.

This method returns the following error codes:

  • PERMISSION_DENIED for access errors

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage your Google Classroom class rosters
  • View your Google Classroom class rosters

Input

This building block consumes 4 input parameters

  = Parameter name
  = Format

pageSize INTEGER

Maximum number of items to return. Zero means no maximum.

The server may return fewer than the specified number of results

courseId STRING

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

userId STRING

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

pageToken STRING

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

Output

This building block provides 6 output parameters

  = Parameter name
  = Format

nextPageToken STRING

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

invitations[] OBJECT

An invitation to join a course

invitations[].courseId STRING

Identifier of the course to invite the user to

invitations[].id STRING

Identifier assigned by Classroom.

Read-only

invitations[].role ENUMERATION

Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED

invitations[].userId STRING

Identifier of the invited user.

When specified as a parameter of a request, this identifier can be set to one of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user