Method: courses.studentGroups.list

Returns a list of groups in a course.

This method returns the following error codes:

  • NOT_FOUND if the course does not exist.

HTTP request

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Required. The identifier of the course.

Query parameters

Parameters
pageSize

integer

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum, which is currently set to 75 items.

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.
previewVersion

enum (PreviewVersion)

Optional. The preview version of the API. This must be set in order to access new API capabilities made available to developers in the Preview Program.

Request body

The request body must be empty.

Response body

Response when listing student groups.

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

JSON representation 
{
  "studentGroups": [
    {
      object (StudentGroup)
    }
  ],
  "nextPageToken": string
}
Fields
studentGroups[]

object (StudentGroup)

The student groups.
nextPageToken

string

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.