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:
-
PERMISSION_DENIEDfor access errors .
HTTP request
GET https://classroom.googleapis.com/v1/invitations
The URL uses gRPC Transcoding syntax.
Query parameters
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
courseId
string
Restricts returned invitations to those for a course with the specified identifier.
pageSize
integer
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.
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.
Request body
The request body must be empty.
Response body
Response when listing invitations.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"invitations"
:
[
{
object (
|
| Fields | |
|---|---|
invitations[]
|
Invitations that match the list request. |
nextPageToken
|
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:
-
https://www.googleapis.com/auth/classroom.rosters -
https://www.googleapis.com/auth/classroom.rosters.readonly
For more information, see the Authorization guide .
