2026-01-14
▼ ▲ classroom.courses.studentGroups.create
Path : v1/courses/{courseId}/studentGroups
Flat Path : v1/courses/{courseId}/studentGroups
HTTP Method : POST
Parameters :
courseId
Description : Required. The identifier of the course.
Location : path
Required : Yes
Type : string
Parameter Order : courseId
Scopes : https://www.googleapis.com/auth/classroom.rosters
Description : Creates a student group for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or for access errors. * `NOT_FOUND` if the course does not exist or the requesting user doesn't have access to the course. * `FAILED_PRECONDITION` if creating the student group would exceed the maximum number of student groups per course.
▼ ▲ classroom.courses.studentGroups.delete
Path : v1/courses/{courseId}/studentGroups/{id}
Flat Path : v1/courses/{courseId}/studentGroups/{id}
HTTP Method : DELETE
Parameters :
courseId
Description : Required. The identifier of the course containing the student group to delete.
Location : path
Required : Yes
Type : string
id
Description : Required. The identifier of the student group to delete.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.rosters
Description : Deletes a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.
▼ ▲ classroom.courses.studentGroups.patch
Path : v1/courses/{courseId}/studentGroups/{id}
Flat Path : v1/courses/{courseId}/studentGroups/{id}
HTTP Method : PATCH
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
id
Description : Required. Identifier of the student group.
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: * `title`
Location : query
Type : string
Format : google-fieldmask
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.rosters
Description : Updates one or more fields in a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.
▼ ▲ classroom.courses.studentGroups.list
Path : v1/courses/{courseId}/studentGroups
Flat Path : v1/courses/{courseId}/studentGroups
HTTP Method : GET
Parameters :
courseId
Description : Required. The identifier of the course.
Location : path
Required : Yes
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : 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.
Location : query
Type : string
Parameter Order : courseId
Scopes :
Description : Returns a list of groups in a course. This method returns the following error codes: * `NOT_FOUND` if the course does not exist.
▼ ▲ classroom.courses.studentGroups.studentGroupMembers.create
Path : v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Flat Path : v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
HTTP Method : POST
Parameters :
courseId
Description : Required. The identifier of the course.
Location : path
Required : Yes
Type : string
studentGroupId
Description : Required. The identifier of the student group.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.rosters
Description : Creates a student group member for a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or member for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `ALREADY_EXISTS` if the student group member already exists. * `FAILED_PRECONDITION` if attempting to add a member to a student group that has reached its member limit.
▼ ▲ classroom.courses.studentGroups.studentGroupMembers.delete
Path : v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Flat Path : v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
HTTP Method : DELETE
Parameters :
courseId
Description : Required. The identifier of the course containing the relevant student group.
Location : path
Required : Yes
Type : string
studentGroupId
Description : Required. The identifier of the student group containing the student group member to delete.
Location : path
Required : Yes
Type : string
userId
Description : Required. The identifier of the student group member to delete.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.rosters
Description : Deletes a student group member. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group member or for access errors. * `NOT_FOUND` if the student group member does not exist or the user does not have access to the student group.
▼ ▲ classroom.courses.studentGroups.studentGroupMembers.list
Path : v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Flat Path : v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
HTTP Method : GET
Parameters :
courseId
Description : Required. The identifier of the course.
Location : path
Required : Yes
Type : string
studentGroupId
Description : Required. The identifier of the student group.
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
Location : query
Type : integer
Format : int32
pageToken
Description : 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.
Location : query
Type : string
Parameter Order :
Scopes :
Description : Returns a list of students in a group. This method returns the following error codes: * `NOT_FOUND` if the course or student group does not exist.