Google Classroom API
Manages classes, rosters, and invitations in Google Classroom.
Education#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Manages classes, rosters, and invitations in Google Classroom.
Endpoints 105
courses
- GETReturns a list of courses that the requesting user is permitted to view, restricted to those that match the request
/v1/courses?courseStates=COURSE_STATE_UNSPECIFIED&pageSize=0&pageToken=string&studentId=string&teacherId=stringReturns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation… - POSTCreates a course
/v1/coursesCreates a course. The user specified in ownerId is the owner of the created course and added as a teacher. A non-admin requesting user can only create a… - GETReturns a course
/v1/courses/:idReturns a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or… - PUTUpdates a course
/v1/courses/:idUpdates a course. Note: Unlike other fields, levels is not cleared if omitted from the request. The UpdateCourse method only modifies levels if it is… - DELETEDeletes a course
/v1/courses/:idDeletes a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested course or… - PATCHUpdates one or more fields in a course
/v1/courses/:id?updateMask=stringUpdates one or more fields in a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to modify… - GETReturns the grading period settings in a course
/v1/courses/:courseId/gradingPeriodSettingsReturns the grading period settings in a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user isn't permitted to… - PATCHUpdates grading period settings of a course
/v1/courses/:courseId/gradingPeriodSettings?updateMask=stringUpdates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course…
courses.aliases
- GETReturns a list of aliases for a course
/v1/courses/:courseId/aliases?pageSize=0&pageToken=stringReturns a list of aliases for a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access… - POSTCreates an alias for a course
/v1/courses/:courseId/aliasesCreates an alias for a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create the alias… - DELETEDeletes an alias of a course
/v1/courses/:courseId/aliases/:aliasDeletes an alias of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to remove the alias…
courses.announcements
- GETReturns a list of announcements that the requester is permitted to view
/v1/courses/:courseId/announcements?announcementStates=ANNOUNCEMENT_STATE_UNSPECIFIED&orderBy=string&pageSize=0&pageToken=stringReturns a list of announcements that the requester is permitted to view. Course students may only view PUBLISHED announcements. Course teachers and domain… - POSTCreates an announcement
/v1/courses/:courseId/announcementsCreates an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested… - GETReturns an announcement
/v1/courses/:courseId/announcements/:idReturns an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested… - DELETEDeletes an announcement
/v1/courses/:courseId/announcements/:idDeletes an announcement. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding announcement item.… - PATCHUpdates one or more fields of an announcement
/v1/courses/:courseId/announcements/:id?updateMask=stringUpdates one or more fields of an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not… - GETGets metadata for Classroom add-ons in the context of a specific post
/v1/courses/:courseId/announcements/:itemId/addOnContext?addOnToken=string&attachmentId=string&postId=stringGets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call… - POSTModifies assignee mode and options of an announcement
/v1/courses/:courseId/announcements/:id:modifyAssigneesModifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns…
courses.announcements.addOnAttachments
- GETReturns all attachments created by an add-on under the post
/v1/courses/:courseId/announcements/:itemId/addOnAttachments?pageSize=0&pageToken=string&postId=stringReturns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new… - POSTCreates an add-on attachment under a post
/v1/courses/:courseId/announcements/:itemId/addOnAttachments?addOnToken=string&postId=stringCreates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following… - GETReturns an add-on attachment
/v1/courses/:courseId/announcements/:itemId/addOnAttachments/:attachmentId?postId=stringReturns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following… - DELETEDeletes an add-on attachment
/v1/courses/:courseId/announcements/:itemId/addOnAttachments/:attachmentId?postId=stringDeletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *… - PATCHUpdates an add-on attachment
/v1/courses/:courseId/announcements/:itemId/addOnAttachments/:attachmentId?postId=string&updateMask=stringUpdates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *…
courses.courseWork
- GETReturns a list of course work that the requester is permitted to view
/v1/courses/:courseId/courseWork?courseWorkStates=COURSE_WORK_STATE_UNSPECIFIED&orderBy=string&pageSize=0&pageToken=stringReturns a list of course work that the requester is permitted to view. Course students may only view PUBLISHED course work. Course teachers and domain… - POSTCreates course work
/v1/courses/:courseId/courseWorkCreates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the OAuth client… - GETReturns course work
/v1/courses/:courseId/courseWork/:idReturns course work. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course… - DELETEDeletes a course work
/v1/courses/:courseId/courseWork/:idDeletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item.… - PATCHUpdates one or more fields of a course work
/v1/courses/:courseId/courseWork/:id?updateMask=stringUpdates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This… - GETGets metadata for Classroom add-ons in the context of a specific post
/v1/courses/:courseId/courseWork/:itemId/addOnContext?addOnToken=string&attachmentId=string&postId=stringGets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call… - POSTModifies assignee mode and options of a coursework
/v1/courses/:courseId/courseWork/:id:modifyAssigneesModifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the… - PATCHUpdates a rubric
/v1/courses/:courseId/courseWork/:courseWorkId/rubric?id=string&updateMask=stringUpdates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are limited once grading has started.…
courses.courseWork.addOnAttachments
- GETReturns all attachments created by an add-on under the post
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments?pageSize=0&pageToken=string&postId=stringReturns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new… - POSTCreates an add-on attachment under a post
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments?addOnToken=string&postId=stringCreates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following… - GETReturns an add-on attachment
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments/:attachmentId?postId=stringReturns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following… - DELETEDeletes an add-on attachment
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments/:attachmentId?postId=stringDeletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *… - PATCHUpdates an add-on attachment
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments/:attachmentId?postId=string&updateMask=stringUpdates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *…
courses.courseWork.addOnAttachments.studentSubmissions
- GETReturns a student submission for an add-on attachment
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments/:attachmentId/studentSubmissions/:submissionId?postId=stringReturns a student submission for an add-on attachment. This method returns the following error codes: * PERMISSION_DENIED for access errors. *… - PATCHUpdates data associated with an add-on attachment submission
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments/:attachmentId/studentSubmissions/:submissionId?postId=string&updateMask=stringUpdates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to… - GETReturns a list of student submissions that the requester is permitted to view
/v1/courses/:courseId/courseWork/:itemId/addOnAttachments/:attachmentId/studentSubmissions?pageSize=0&pageToken=stringReturns a list of student submissions that the requester is permitted to view. This method returns the following error codes: * PERMISSION_DENIED for access…
courses.courseWork.rubrics
- GETReturns a list of rubrics that the requester is permitted to view
/v1/courses/:courseId/courseWork/:courseWorkId/rubrics?pageSize=0&pageToken=stringReturns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * PERMISSION_DENIED for access errors. *… - POSTCreates a rubric
/v1/courses/:courseId/courseWork/:courseWorkId/rubricsCreates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see licensing requirements. For further details,… - GETReturns a rubric
/v1/courses/:courseId/courseWork/:courseWorkId/rubrics/:idReturns a rubric. This method returns the following error codes: * PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the request is malformed. *… - DELETEDeletes a rubric
/v1/courses/:courseId/courseWork/:courseWorkId/rubrics/:idDeletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see licensing requirements. This request must be… - PATCHUpdates a rubric
/v1/courses/:courseId/courseWork/:courseWorkId/rubrics/:id?updateMask=stringUpdates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are limited once grading has started.…
courses.courseWork.studentSubmissions
- GETReturns a student submission
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:idReturns a student submission. * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, course work, or student submission… - PATCHUpdates one or more fields of a student submission
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id?updateMask=stringUpdates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change… - GETReturns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the…
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions?late=LATE_VALUES_UNSPECIFIED&pageSize=0&pageToken=string&states=SUBMISSION_STATE_UNSPECIFIED&userId=stringReturns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (-) may be specified as… - POSTModifies attachments of student submission
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:modifyAttachmentsModifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a workType of… - POSTReclaims a student submission on behalf of the student that owns it
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:reclaimReclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the… - POSTReturns a student submission
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:returnReturns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission… - POSTTurns in a student submission
/v1/courses/:courseId/courseWork/:courseWorkId/studentSubmissions/:id:turnInTurns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission…
courses.courseWorkMaterials
- GETReturns a list of course work material that the requester is permitted to view
/v1/courses/:courseId/courseWorkMaterials?courseWorkMaterialStates=COURSEWORK_MATERIAL_STATE_UNSPECIFIED&materialDriveId=string&materialLink=string&orderBy=string&pageSize=0&pageToken=stringReturns a list of course work material that the requester is permitted to view. Course students may only view PUBLISHED course work material. Course teachers… - POSTCreates a course work material
/v1/courses/:courseId/courseWorkMaterialsCreates a course work material. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the… - GETReturns a course work material
/v1/courses/:courseId/courseWorkMaterials/:idReturns a course work material. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the… - DELETEDeletes a course work material
/v1/courses/:courseId/courseWorkMaterials/:idDeletes a course work material. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work… - PATCHUpdates one or more fields of a course work material
/v1/courses/:courseId/courseWorkMaterials/:id?updateMask=stringUpdates one or more fields of a course work material. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project… - GETGets metadata for Classroom add-ons in the context of a specific post
/v1/courses/:courseId/courseWorkMaterials/:itemId/addOnContext?addOnToken=string&attachmentId=string&postId=stringGets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call…
courses.courseWorkMaterials.addOnAttachments
- GETReturns all attachments created by an add-on under the post
/v1/courses/:courseId/courseWorkMaterials/:itemId/addOnAttachments?pageSize=0&pageToken=string&postId=stringReturns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new… - POSTCreates an add-on attachment under a post
/v1/courses/:courseId/courseWorkMaterials/:itemId/addOnAttachments?addOnToken=string&postId=stringCreates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following… - GETReturns an add-on attachment
/v1/courses/:courseId/courseWorkMaterials/:itemId/addOnAttachments/:attachmentId?postId=stringReturns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following… - DELETEDeletes an add-on attachment
/v1/courses/:courseId/courseWorkMaterials/:itemId/addOnAttachments/:attachmentId?postId=stringDeletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *… - PATCHUpdates an add-on attachment
/v1/courses/:courseId/courseWorkMaterials/:itemId/addOnAttachments/:attachmentId?postId=string&updateMask=stringUpdates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *…
courses.posts
- GETGets metadata for Classroom add-ons in the context of a specific post
/v1/courses/:courseId/posts/:postId/addOnContext?addOnToken=string&attachmentId=string&itemId=stringGets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call…
courses.posts.addOnAttachments
- GETReturns all attachments created by an add-on under the post
/v1/courses/:courseId/posts/:postId/addOnAttachments?itemId=string&pageSize=0&pageToken=stringReturns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new… - POSTCreates an add-on attachment under a post
/v1/courses/:courseId/posts/:postId/addOnAttachments?addOnToken=string&itemId=stringCreates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following… - GETReturns an add-on attachment
/v1/courses/:courseId/posts/:postId/addOnAttachments/:attachmentId?itemId=stringReturns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following… - DELETEDeletes an add-on attachment
/v1/courses/:courseId/posts/:postId/addOnAttachments/:attachmentId?itemId=stringDeletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *… - PATCHUpdates an add-on attachment
/v1/courses/:courseId/posts/:postId/addOnAttachments/:attachmentId?itemId=string&updateMask=stringUpdates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: *…
courses.posts.addOnAttachments.studentSubmissions
- GETReturns a student submission for an add-on attachment
/v1/courses/:courseId/posts/:postId/addOnAttachments/:attachmentId/studentSubmissions/:submissionId?itemId=stringReturns a student submission for an add-on attachment. This method returns the following error codes: * PERMISSION_DENIED for access errors. *… - PATCHUpdates data associated with an add-on attachment submission
/v1/courses/:courseId/posts/:postId/addOnAttachments/:attachmentId/studentSubmissions/:submissionId?itemId=string&updateMask=stringUpdates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to…
courses.studentGroups
- GETReturns a list of groups in a course
/v1/courses/:courseId/studentGroups?pageSize=0&pageToken=stringReturns a list of groups in a course. This method returns the following error codes: * NOT_FOUND if the course does not exist. - POSTCreates a student group for a course
/v1/courses/:courseId/studentGroupsCreates 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… - DELETEDeletes a student group
/v1/courses/:courseId/studentGroups/:idDeletes a student group. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested… - PATCHUpdates one or more fields in a student group
/v1/courses/:courseId/studentGroups/:id?updateMask=stringUpdates 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…
courses.studentGroups.studentGroupMembers
- GETReturns a list of students in a group
/v1/courses/:courseId/studentGroups/:studentGroupId/studentGroupMembers?pageSize=0&pageToken=stringReturns 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. - POSTCreates a student group member for a student group
/v1/courses/:courseId/studentGroups/:studentGroupId/studentGroupMembersCreates a student group member for a student group. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted… - DELETEDeletes a student group member
/v1/courses/:courseId/studentGroups/:studentGroupId/studentGroupMembers/:userIdDeletes a student group member. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the…
courses.students
- GETReturns a list of students of this course that the requester is permitted to view
/v1/courses/:courseId/students?pageSize=0&pageToken=stringReturns 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… - POSTAdds a user as a student of a course
/v1/courses/:courseId/students?enrollmentCode=stringAdds a user as a student of a course. Domain administrators are permitted to directly add users within their domain as students to courses within their… - GETReturns a student of a course
/v1/courses/:courseId/students/:userIdReturns a student of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view students of… - DELETEDeletes a student of a course
/v1/courses/:courseId/students/:userIdDeletes a student of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete students…
courses.teachers
- GETReturns a list of teachers of this course that the requester is permitted to view
/v1/courses/:courseId/teachers?pageSize=0&pageToken=stringReturns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND if the course… - POSTCreates a teacher of a course
/v1/courses/:courseId/teachersCreates a teacher of a course. Domain administrators are permitted to directly add users within their domain as teachers to courses within their domain.… - GETReturns a teacher of a course
/v1/courses/:courseId/teachers/:userIdReturns a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view teachers of… - DELETERemoves the specified teacher from the specified course
/v1/courses/:courseId/teachers/:userIdRemoves the specified teacher from the specified course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not…
courses.topics
- GETReturns the list of topics that the requester is permitted to view
/v1/courses/:courseId/topics?pageSize=0&pageToken=stringReturns the list of topics that the requester is permitted to view. This method returns the following error codes: * PERMISSION_DENIED if the requesting user… - POSTCreates a topic
/v1/courses/:courseId/topicsCreates a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course,… - GETReturns a topic
/v1/courses/:courseId/topics/:idReturns a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or… - DELETEDeletes a topic
/v1/courses/:courseId/topics/:idDeletes a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not allowed to delete the requested topic or for… - PATCHUpdates one or more fields of a topic
/v1/courses/:courseId/topics/:id?updateMask=stringUpdates one or more fields of a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create…
invitations
- POSTAccepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the…
/v1/invitations/:id:acceptAccepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may… - GETReturns a list of invitations that the requesting user is permitted to view, restricted to those that match the list…
/v1/invitations?courseId=string&pageSize=0&pageToken=string&userId=stringReturns 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 user_id… - POSTCreates an invitation
/v1/invitationsCreates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns… - GETReturns an invitation
/v1/invitations/:idReturns an invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view the requested… - DELETEDeletes an invitation
/v1/invitations/:idDeletes an invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested…
registrations
- POSTCreates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination…
/v1/registrationsCreates a Registration, causing Classroom to start sending notifications from the provided feed to the destination provided in cloudPubSubTopic. Returns the… - DELETEDeletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.
/v1/registrations/:registrationIdDeletes a Registration, causing Classroom to stop sending notifications for that Registration.
userProfiles
- GETReturns a user profile
/v1/userProfiles/:userIdReturns a user profile. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access this user…
userProfiles.guardianInvitations
- GETReturns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters…
/v1/userProfiles/:studentId/guardianInvitations?invitedEmailAddress=string&pageSize=0&pageToken=string&states=GUARDIAN_INVITATION_STATE_UNSPECIFIEDReturns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following… - POSTCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's…
/v1/userProfiles/:studentId/guardianInvitationsCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the… - GETReturns a specific guardian invitation
/v1/userProfiles/:studentId/guardianInvitations/:invitationIdReturns a specific guardian invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view… - PATCHModifies a guardian invitation
/v1/userProfiles/:studentId/guardianInvitations/:invitationId?updateMask=stringModifies a guardian invitation. Currently, the only valid modification is to change the state from PENDING to COMPLETE. This has the effect of withdrawing the…
userProfiles.guardians
- GETReturns a specific guardian
/v1/userProfiles/:studentId/guardians/:guardianIdReturns a specific guardian. This method returns the following error codes: * PERMISSION_DENIED if no user that matches the provided student_id is visible to… - DELETEDeletes a guardian
/v1/userProfiles/:studentId/guardians/:guardianIdDeletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns… - GETReturns a list of guardians that the requesting user is permitted to view, restricted to those that match the request
/v1/userProfiles/:studentId/guardians?invitedEmailAddress=string&pageSize=0&pageToken=stringReturns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that…
API details
- Base URL
https://classroom.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 24 scopes
An API key in the key query parameter - Operations
- 105 operations on 57 pathsGET 44POST 25DELETE 18PATCH 17PUT 1
- Main resources
- courses 8courses.courseWork 8courses.announcements 7courses.courseWork.studentSubmissions 7courses.courseWorkMaterials 6courses.announcements.addOnAttachments 5courses.courseWork.addOnAttachments 5courses.courseWork.rubrics 5courses.courseWorkMaterials.addOnAttachments 5courses.posts.addOnAttachments 5
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Google Classroom API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Google Classroom API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 24 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request” (GET /v1/courses?courseStates=COURSE_STATE_UNSPECIFIED&pageSize=0&pageToken=string&studentId=string&teacherId=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Google Classroom API?
Manages classes, rosters, and invitations in Google Classroom. It is listed under Education and has 105 endpoints.
Who publishes the Google Classroom API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Google Classroom API?
Requests go to https://classroom.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Google Classroom API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 24 scopes; an API key in the key query parameter.
How many endpoints does the Google Classroom API have?
105 operations on 57 paths (44 GET, 25 POST, 18 DELETE, 17 PATCH, 1 PUT). The largest groups are courses, courses.courseWork, courses.announcements, courses.courseWork.studentSubmissions.
Is forking the Google Classroom API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.