- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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 |
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an |
Query parameters
Parameters | |
---|---|
pageSize |
Maximum number of items to return. The default is 30 if unspecified or The server may return fewer than the specified number of results. |
pageToken |
The |
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 ( |
Fields | |
---|---|
students[] |
Students who 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
https://www.googleapis.com/auth/classroom.profile.emails
https://www.googleapis.com/auth/classroom.profile.photos
For more information, see the Authorization guide.