Method: courses.students.list

Returns a list of students of this course that the requester is permitted to view.

This method returns the following error codes:

  • NOT_FOUND if the course does not exist.
  • PERMISSION_DENIED for access errors.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Query parameters

Parameters
pageSize

integer

Maximum number of items to return. The default is 30 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 students.

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

JSON representation 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Fields
students[]

object (Student)

Students who match the list request.
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
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

For more information, see the Authorization guide.